tik_manager4.objects.guard
==========================

.. py:module:: tik_manager4.objects.guard

.. autoapi-nested-parse::

   Module to communicate with other modules regarding the application state.



Classes
-------

.. autoapisummary::

   tik_manager4.objects.guard.Guard


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

.. py:class:: Guard

   Global object that holds the state of the application.


   .. py:method:: set_authentication_status(state)
      :classmethod:


      Set the authentication status of the user.

      Args:
          state (bool): The authentication status.



   .. py:method:: set_category_definitions(definitions)
      :classmethod:


      Set the category definitions.

      Args:
          definitions (Settings): The category definitions.



   .. py:method:: set_commons(commons)
      :classmethod:


      Set the commons object.

      Args:
          commons (Commons): The commons object.



   .. py:method:: set_database_root(root)
      :classmethod:


      Set the database root path.

      Args:
          root (str): The database root path.



   .. py:method:: set_dcc(dcc_name)
      :classmethod:


      Set the DCC name.

      Args:
          dcc_name (str): The name of the DCC.



   .. py:method:: set_dcc_handler(handler)
      :classmethod:


      Set the DCC handler object.

      Args:
          handler (object): The DCC handler object.



   .. py:method:: set_localize_settings(localize_settings)
      :classmethod:


      Set the localize settings object.

      Args:
          localize_settings (Settings): The localize settings object.



   .. py:method:: set_management_handler(handler)
      :classmethod:


      Set the management handler object.

      Args:
          handler (object): The management handler object.



   .. py:method:: set_metadata_definitions(definitions)
      :classmethod:


      Set the metadata definitions.

      Args:
          definitions (Settings): The metadata definitions.



   .. py:method:: set_permission_level(level)
      :classmethod:


      Set the permission level for the current user.



   .. py:method:: set_preview_settings(preview_settings)
      :classmethod:


      Set the preview settings object.

      Args:
          preview_settings (Settings): The preview settings object.



   .. py:method:: set_project_root(root)
      :classmethod:


      Set the project root path.

      Args:
          root (str): The project root path.



   .. py:method:: set_project_settings(project_settings)
      :classmethod:


      Set the project settings object.

      Args:
          project_settings (Settings): The project settings object.



   .. py:method:: set_user(user)
      :classmethod:


      Set the user name.

      Args:
          user (User): The user object.



   .. py:property:: category_definitions
      Return the category definitions.



   .. py:attribute:: commons
      :value: None



   .. py:property:: database_root
      Return the database root path.



   .. py:property:: dcc
      Return the DCC name.



   .. py:property:: dcc_handler
      Return the DCC handler object.



   .. py:property:: email
      Return the email of the user.



   .. py:property:: is_authenticated
      Return the authentication status of the user.



   .. py:attribute:: localize_settings
      :value: None



   .. py:property:: management_handler
      Return the management handler object.



   .. py:property:: metadata_definitions
      Return the metadata definitions.



   .. py:property:: permission_level
      Return the permission level of the user.



   .. py:attribute:: preview_settings
      :value: None



   .. py:property:: project_root
      Return the project root path.



   .. py:attribute:: project_settings
      :value: None



   .. py:property:: user
      Return the user name.