tik_manager4.core.constants
===========================

.. py:module:: tik_manager4.core.constants

.. autoapi-nested-parse::

   Constants used in the Tik Manager application.



Classes
-------

.. autoapisummary::

   tik_manager4.core.constants.BranchingModes
   tik_manager4.core.constants.ColorCodes
   tik_manager4.core.constants.DataTypes
   tik_manager4.core.constants.ObjectType
   tik_manager4.core.constants.ValidationResult
   tik_manager4.core.constants.ValidationState


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

.. py:class:: BranchingModes

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


   Enumeration of branching modes.


   .. py:attribute:: ACTIVE
      :value: 'Active Branches'



   .. py:attribute:: PASSIVE
      :value: 'Passive Branches'



.. py:class:: ColorCodes

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


   Enumeration of color codes.


   .. py:attribute:: DELETED
      :value: '#FF0000'



   .. py:attribute:: LIVE
      :value: '#CA75FF'



   .. py:attribute:: NORMAL
      :value: '#FFFFFF'



   .. py:attribute:: PROMOTED
      :value: '#00FF00'



.. py:class:: DataTypes

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


   Widget Data Types.


   .. py:method:: get_storable_types()
      :staticmethod:


      Return a list of storable data types values.



   .. py:attribute:: BOOLEAN
      :value: 'boolean'



   .. py:attribute:: BUTTON
      :value: 'button'



   .. py:attribute:: CATEGORYLIST
      :value: 'categoryList'



   .. py:attribute:: COMBO
      :value: 'combo'



   .. py:attribute:: DROPLIST
      :value: 'dropList'



   .. py:attribute:: FILEBROWSER
      :value: 'fileBrowser'



   .. py:attribute:: FLOAT
      :value: 'float'



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



   .. py:attribute:: INFO
      :value: 'info'



   .. py:attribute:: INTEGER
      :value: 'integer'



   .. py:attribute:: LIST
      :value: 'list'



   .. py:attribute:: MULTI
      :value: 'multi'



   .. py:attribute:: PATHBROWSER
      :value: 'pathBrowser'



   .. py:attribute:: SEPARATOR
      :value: 'separator'



   .. py:attribute:: SPINNERFLOAT
      :value: 'spinnerFloat'



   .. py:attribute:: SPINNERINT
      :value: 'spinnerInt'



   .. py:attribute:: STRING
      :value: 'string'



   .. py:attribute:: SUBPROJECTBROWSER
      :value: 'subprojectBrowser'



   .. py:attribute:: VALIDATEDSTRING
      :value: 'validatedString'



   .. py:attribute:: VECTOR2FLOAT
      :value: 'vector2Float'



   .. py:attribute:: VECTOR2INT
      :value: 'vector2Int'



   .. py:attribute:: VECTOR3FLOAT
      :value: 'vector3Float'



   .. py:attribute:: VECTOR3INT
      :value: 'vector3Int'



   .. py:property:: is_numeric


   .. py:property:: is_storable
      Return True if the data type is storable in the database.



.. py:class:: ObjectType

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


   Enumeration of object types.


   .. py:attribute:: CATEGORY
      :value: 'category'



   .. py:attribute:: ENTITY
      :value: 'entity'



   .. py:attribute:: PROJECT
      :value: 'project'



   .. py:attribute:: PUBLISH
      :value: 'publish'



   .. py:attribute:: PUBLISH_VERSION
      :value: 'publish_version'



   .. py:attribute:: SUBPROJECT
      :value: 'subproject'



   .. py:attribute:: TASK
      :value: 'task'



   .. py:attribute:: USER
      :value: 'user'



   .. py:attribute:: WORK
      :value: 'work'



   .. py:attribute:: WORK_VERSION
      :value: 'work_version'



.. py:class:: ValidationResult

   Dataclass to store validation results.


   .. py:attribute:: allow_proceed
      :type:  bool
      :value: False



   .. py:attribute:: message
      :type:  str


   .. py:attribute:: state
      :type:  ValidationState


.. py:class:: ValidationState

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


   Enumeration of validation states.


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



   .. py:attribute:: SUCCESS
      :value: 'success'



   .. py:attribute:: WARNING
      :value: 'warning'