tik_manager4.ui.main
====================

.. py:module:: tik_manager4.ui.main

.. autoapi-nested-parse::

   Main UI for Tik Manager 4.

   Maya test:

   from importlib import reload
   import sys
   p_path = "D:\dev\tik_manager4\"
   if p_path not in sys.path:
       sys.path.append(p_path)

   kill_list = []
   for name, _module in sys.modules.items():
       if name.startswith("tik_manager4"):
           kill_list.append(name)
   for x in kill_list:
       sys.modules.pop(x)

   # from tik_manager4.ui.Qt import QtWidgets, QtCore, QtGui
   from tik_manager4.ui import main
   reload(main)
   main.launch(dcc="Maya")



Attributes
----------

.. autoapisummary::

   tik_manager4.ui.main.LOG
   tik_manager4.ui.main.WINDOW_NAME
   tik_manager4.ui.main.app


Classes
-------

.. autoapisummary::

   tik_manager4.ui.main.MainUI


Functions
---------

.. autoapisummary::

   tik_manager4.ui.main.launch


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

.. py:class:: MainUI(main_object, window_name=WINDOW_NAME, **kwargs)

   Bases: :py:obj:`tik_manager4.ui.Qt.QtWidgets.QMainWindow`


   Main UI for Tik Manager 4.


   .. py:method:: build_bars()

      Build the menu bar.



   .. py:method:: build_buttons()

      Build the buttons



   .. py:method:: build_extensions()

      Collect the management extensions and build the menu.



   .. py:method:: closeEvent(event)

      Override the close event to save the window state.



   .. py:method:: initialize_mcv()

      Initialize the model-control-views.



   .. py:method:: management_connect(platform_name=None)

      Convenience function to connect to a management platform.



   .. py:method:: management_lock()

      Lock certain UI elements if the project is getting driven by a
      management platform.



   .. py:method:: on_add_new_user()

      Launch add new user dialog.



   .. py:method:: on_check_for_updates()

      Check for updates.



   .. py:method:: on_create_new_project()

      Create a new project.



   .. py:method:: on_element_view(element_type, element_path)

      View the selected element.

      Args:
          element_type (str): The type of the element to view.
          element_path (str): The path of the element to view.



   .. py:method:: on_ingest_version()

      Iterate a version over the selected work in the ui.



   .. py:method:: on_login()

      Launch login dialog.



   .. py:method:: on_new_version()

      Create a new version.



   .. py:method:: on_new_work(from_selection=False)

      Create a new work.



   .. py:method:: on_publish_scene()

      Bring up the publish scene dialog.



   .. py:method:: on_publish_snapshot()

      Immediately snapshot publish the selected version of the work item.



   .. py:method:: on_purge_local_purgatory()

      Purge the local purgatory.



   .. py:method:: on_purge_project_purgatory()

      Purge the project purgatory.



   .. py:method:: on_save_any_file(file_path=None, folder=False)

      Launch the save any file dialog.



   .. py:method:: on_set_project(message='')

      Show a status message.



   .. py:method:: on_set_project_as_template()

      Set the current project as a template.



   .. py:method:: on_settings()

      Launch the settings dialog.



   .. py:method:: on_show_preview()

      Make a dropdown list for the available previews and play selected one.



   .. py:method:: on_work_from_template()

      Launch the work from template dialog.



   .. py:method:: refresh()

      Refresh the entire UI.



   .. py:method:: refresh_categories()

      Refresh the categories' ui.



   .. py:method:: refresh_project()

      Refresh the project ui.



   .. py:method:: refresh_subprojects()

      Refresh the subprojects' ui.



   .. py:method:: refresh_tasks()

      Refresh the tasks' ui.



   .. py:method:: refresh_versions()

      Refresh the versions' ui.



   .. py:method:: resume_last_state()

      Resume the last selection from the user settings.



   .. py:method:: set_last_state()

      Set the last selections for the user



   .. py:method:: support_splash(count_limit=10)

      Show the support splash screen if its time and not disabled.



   .. py:method:: toggle_purgatory_mode(state)

      Toggle the visibility of deleted items.



.. py:function:: launch(dcc='Standalone', dont_show=False)

   Launch the main UI.


.. py:data:: LOG

.. py:data:: WINDOW_NAME

.. py:data:: app