ducpy.utils.enums
=================

.. py:module:: ducpy.utils.enums


Classes
-------

.. autoapisummary::

   ducpy.utils.enums.DesignStandard
   ducpy.utils.enums.Theme
   ducpy.utils.enums.ChartType
   ducpy.utils.enums.PointerType
   ducpy.utils.enums.UserIdleState
   ducpy.utils.enums.LineHead
   ducpy.utils.enums.Blending
   ducpy.utils.enums.ElementSubset
   ducpy.utils.enums.ElementContentPreference
   ducpy.utils.enums.StrokePreference
   ducpy.utils.enums.StrokeSidePreference
   ducpy.utils.enums.StrokeCap
   ducpy.utils.enums.StrokeJoin
   ducpy.utils.enums.StrokePlacement
   ducpy.utils.enums.TextAlign
   ducpy.utils.enums.VerticalAlign
   ducpy.utils.enums.BezierMirroring
   ducpy.utils.enums.FontFamily
   ducpy.utils.enums.FillStyle
   ducpy.utils.enums.StrokeStyle
   ducpy.utils.enums.ArrowType
   ducpy.utils.enums.Theme
   ducpy.utils.enums.ImageStatus
   ducpy.utils.enums.ElementType
   ducpy.utils.enums.ToolType
   ducpy.utils.enums.HandleType


Module Contents
---------------

.. py:class:: DesignStandard

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: DUC
      :value: 10



   .. py:attribute:: ABNT
      :value: 11



   .. py:attribute:: ANSI
      :value: 12



   .. py:attribute:: ISO
      :value: 13



   .. py:attribute:: DIN
      :value: 14



   .. py:attribute:: JIS
      :value: 15



   .. py:attribute:: GB
      :value: 16



   .. py:attribute:: BSI
      :value: 17



.. py:class:: Theme

   Bases: :py:obj:`enum.StrEnum`


   Enum where members are also (and must be) strings

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: LIGHT
      :value: 'light'



   .. py:attribute:: DARK
      :value: 'dark'



.. py:class:: ChartType

   Bases: :py:obj:`enum.StrEnum`


   Enum where members are also (and must be) strings

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: BAR
      :value: 'bar'



   .. py:attribute:: LINE
      :value: 'line'



.. py:class:: PointerType

   Bases: :py:obj:`enum.StrEnum`


   Enum where members are also (and must be) strings

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: MOUSE
      :value: 'mouse'



   .. py:attribute:: PEN
      :value: 'pen'



   .. py:attribute:: TOUCH
      :value: 'touch'



.. py:class:: UserIdleState

   Bases: :py:obj:`enum.StrEnum`


   Enum where members are also (and must be) strings

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: ACTIVE
      :value: 'active'



   .. py:attribute:: AWAY
      :value: 'away'



   .. py:attribute:: IDLE
      :value: 'idle'



.. py:class:: LineHead

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: ARROW
      :value: 10



   .. py:attribute:: BAR
      :value: 11



   .. py:attribute:: CIRCLE
      :value: 12



   .. py:attribute:: CIRCLE_OUTLINED
      :value: 13



   .. py:attribute:: TRIANGLE
      :value: 14



   .. py:attribute:: TRIANGLE_OUTLINED
      :value: 15



   .. py:attribute:: DIAMOND
      :value: 16



   .. py:attribute:: DIAMOND_OUTLINED
      :value: 17



   .. py:attribute:: CROSS
      :value: 18



   .. py:attribute:: OPEN_ARROW
      :value: 19



   .. py:attribute:: REVERSED_ARROW
      :value: 20



   .. py:attribute:: REVERSED_TRIANGLE
      :value: 21



   .. py:attribute:: REVERSED_TRIANGLE_OUTLINED
      :value: 22



   .. py:attribute:: CONE
      :value: 23



   .. py:attribute:: HALF_CONE
      :value: 24



.. py:class:: Blending

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: MULTIPLY
      :value: 11



   .. py:attribute:: SCREEN
      :value: 12



   .. py:attribute:: OVERLAY
      :value: 13



   .. py:attribute:: DARKEN
      :value: 14



   .. py:attribute:: LIGHTEN
      :value: 15



   .. py:attribute:: DIFFERENCE
      :value: 16



   .. py:attribute:: EXCLUSION
      :value: 17



.. py:class:: ElementSubset

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: AUX
      :value: 14



   .. py:attribute:: COTA
      :value: 15



.. py:class:: ElementContentPreference

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: HACHURE
      :value: 10



   .. py:attribute:: CROSS_HATCH
      :value: 11



   .. py:attribute:: SOLID
      :value: 12



   .. py:attribute:: ZIGZAG
      :value: 13



   .. py:attribute:: FILL
      :value: 14



   .. py:attribute:: FIT
      :value: 15



   .. py:attribute:: TILE
      :value: 16



   .. py:attribute:: STRETCH
      :value: 17



   .. py:attribute:: HATCH
      :value: 18



.. py:class:: StrokePreference

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: SOLID
      :value: 10



   .. py:attribute:: DASHED
      :value: 11



   .. py:attribute:: DOTTED
      :value: 12



   .. py:attribute:: CUSTOM
      :value: 13



.. py:class:: StrokeSidePreference

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: TOP
      :value: 10



   .. py:attribute:: BOTTOM
      :value: 11



   .. py:attribute:: LEFT
      :value: 12



   .. py:attribute:: RIGHT
      :value: 13



   .. py:attribute:: CUSTOM
      :value: 14



   .. py:attribute:: ALL
      :value: 15



.. py:class:: StrokeCap

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: BUTT
      :value: 10



   .. py:attribute:: ROUND
      :value: 11



   .. py:attribute:: SQUARE
      :value: 12



.. py:class:: StrokeJoin

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: MITER
      :value: 10



   .. py:attribute:: ROUND
      :value: 11



   .. py:attribute:: BEVEL
      :value: 12



.. py:class:: StrokePlacement

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: INSIDE
      :value: 10



   .. py:attribute:: CENTER
      :value: 11



   .. py:attribute:: OUTSIDE
      :value: 12



.. py:class:: TextAlign

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: LEFT
      :value: 10



   .. py:attribute:: CENTER
      :value: 11



   .. py:attribute:: RIGHT
      :value: 12



.. py:class:: VerticalAlign

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: TOP
      :value: 10



   .. py:attribute:: MIDDLE
      :value: 11



   .. py:attribute:: BOTTOM
      :value: 12



.. py:class:: BezierMirroring

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: NONE
      :value: 10



   .. py:attribute:: ANGLE
      :value: 11



   .. py:attribute:: ANGLE_LENGTH
      :value: 12



.. py:class:: FontFamily

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: VIRGIL
      :value: 1



   .. py:attribute:: HELVETICA
      :value: 2



   .. py:attribute:: CASCADIA
      :value: 3



   .. py:attribute:: EXCALIFONT
      :value: 5



   .. py:attribute:: NUNITO
      :value: 6



   .. py:attribute:: LILITA_ONE
      :value: 7



   .. py:attribute:: COMIC_SHANNS
      :value: 8



   .. py:attribute:: LIBERATION_SANS
      :value: 9



   .. py:attribute:: ROBOTO_MONO
      :value: 10



.. py:class:: FillStyle(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Create a collection of name/value pairs.

   Example enumeration:

   >>> class Color(Enum):
   ...     RED = 1
   ...     BLUE = 2
   ...     GREEN = 3

   Access them by:

   - attribute access:

     >>> Color.RED
     <Color.RED: 1>

   - value lookup:

     >>> Color(1)
     <Color.RED: 1>

   - name lookup:

     >>> Color['RED']
     <Color.RED: 1>

   Enumerations can be iterated over, and know how many members they have:

   >>> len(Color)
   3

   >>> list(Color)
   [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

   Methods can be added to enumerations, and members can have their own
   attributes -- see the documentation for details.


   .. py:attribute:: HACHURE
      :value: 'hachure'



   .. py:attribute:: CROSS_HATCH
      :value: 'cross-hatch'



   .. py:attribute:: SOLID
      :value: 'solid'



   .. py:attribute:: ZIGZAG
      :value: 'zigzag'



.. py:class:: StrokeStyle(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Create a collection of name/value pairs.

   Example enumeration:

   >>> class Color(Enum):
   ...     RED = 1
   ...     BLUE = 2
   ...     GREEN = 3

   Access them by:

   - attribute access:

     >>> Color.RED
     <Color.RED: 1>

   - value lookup:

     >>> Color(1)
     <Color.RED: 1>

   - name lookup:

     >>> Color['RED']
     <Color.RED: 1>

   Enumerations can be iterated over, and know how many members they have:

   >>> len(Color)
   3

   >>> list(Color)
   [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

   Methods can be added to enumerations, and members can have their own
   attributes -- see the documentation for details.


   .. py:attribute:: SOLID
      :value: 'solid'



   .. py:attribute:: DASHED
      :value: 'dashed'



   .. py:attribute:: DOTTED
      :value: 'dotted'



.. py:class:: ArrowType(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Create a collection of name/value pairs.

   Example enumeration:

   >>> class Color(Enum):
   ...     RED = 1
   ...     BLUE = 2
   ...     GREEN = 3

   Access them by:

   - attribute access:

     >>> Color.RED
     <Color.RED: 1>

   - value lookup:

     >>> Color(1)
     <Color.RED: 1>

   - name lookup:

     >>> Color['RED']
     <Color.RED: 1>

   Enumerations can be iterated over, and know how many members they have:

   >>> len(Color)
   3

   >>> list(Color)
   [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

   Methods can be added to enumerations, and members can have their own
   attributes -- see the documentation for details.


   .. py:attribute:: SHARP
      :value: 'sharp'



   .. py:attribute:: ROUND
      :value: 'round'



   .. py:attribute:: ELBOW
      :value: 'elbow'



.. py:class:: Theme

   Bases: :py:obj:`enum.StrEnum`


   Enum where members are also (and must be) strings

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: LIGHT
      :value: 'light'



   .. py:attribute:: DARK
      :value: 'dark'



.. py:class:: ImageStatus

   Bases: :py:obj:`enum.StrEnum`


   Enum where members are also (and must be) strings

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: PENDING
      :value: 'pending'



   .. py:attribute:: SAVED
      :value: 'saved'



   .. py:attribute:: ERROR
      :value: 'error'



.. py:class:: ElementType

   Bases: :py:obj:`enum.StrEnum`


   Enum where members are also (and must be) strings

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: SELECTION
      :value: 'selection'



   .. py:attribute:: RECTANGLE
      :value: 'rectangle'



   .. py:attribute:: DIAMOND
      :value: 'diamond'



   .. py:attribute:: ELLIPSE
      :value: 'ellipse'



   .. py:attribute:: ARROW
      :value: 'arrow'



   .. py:attribute:: LINE
      :value: 'line'



   .. py:attribute:: FREEDRAW
      :value: 'freedraw'



   .. py:attribute:: TEXT
      :value: 'text'



   .. py:attribute:: IMAGE
      :value: 'image'



   .. py:attribute:: POLYGON
      :value: 'polygon'



   .. py:attribute:: TABLE
      :value: 'table'



   .. py:attribute:: DOC
      :value: 'doc'



   .. py:attribute:: FRAME
      :value: 'frame'



   .. py:attribute:: MAGIC_FRAME
      :value: 'magic_frame'



   .. py:attribute:: GROUP
      :value: 'group'



   .. py:attribute:: EMBEDDABLE
      :value: 'embeddable'



   .. py:attribute:: LASER
      :value: 'laser'



   .. py:attribute:: CUSTOM
      :value: 'custom'



.. py:class:: ToolType

   Bases: :py:obj:`enum.StrEnum`


   Enum where members are also (and must be) strings

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: SELECTION
      :value: 'selection'



   .. py:attribute:: RECTANGLE
      :value: 'rectangle'



   .. py:attribute:: DIAMOND
      :value: 'diamond'



   .. py:attribute:: ELLIPSE
      :value: 'ellipse'



   .. py:attribute:: ARROW
      :value: 'arrow'



   .. py:attribute:: LINE
      :value: 'line'



   .. py:attribute:: FREEDRAW
      :value: 'freedraw'



   .. py:attribute:: TEXT
      :value: 'text'



   .. py:attribute:: IMAGE
      :value: 'image'



   .. py:attribute:: ERASER
      :value: 'eraser'



   .. py:attribute:: HAND
      :value: 'hand'



   .. py:attribute:: FRAME
      :value: 'frame'



   .. py:attribute:: MAGICFRAME
      :value: 'magicframe'



   .. py:attribute:: EMBEDDABLE
      :value: 'embeddable'



   .. py:attribute:: RULER
      :value: 'ruler'



   .. py:attribute:: LASER
      :value: 'laser'



   .. py:attribute:: CUSTOM
      :value: 'custom'



.. py:class:: HandleType

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: HANDLE_IN
      :value: 10



   .. py:attribute:: HANDLE_OUT
      :value: 11