tik_manager4.ui.mcv.category_mcv
Classes
Custom QStandardItem for the category columns in the category view. |
|
Custom QVBoxLayout for the category layout. |
|
Custom QStandardItemModel for the category view. |
|
Custom QTreeView for the category view. |
|
Custom QStandardItem for the publish items in the category view. |
|
Custom QStandardItem for the work items in the category view. |
Module Contents
- class TikCategoryColumnItem(text)
Bases:
tik_manager4.ui.Qt.QtGui.QStandardItemCustom QStandardItem for the category columns in the category view.
- class TikCategoryLayout(*args, **kwargs)
Bases:
tik_manager4.ui.Qt.QtWidgets.QVBoxLayoutCustom QVBoxLayout for the category layout.
- clear()
Refresh the layout.
- get_active_category()
Get the active category object and return it.
- get_category_index()
Get the index of the category.
- on_category_change(index)
Update works and publishes when category changed. Args:
index (int): The index of the category tab.
- on_mode_change(_event)
Change the mode.
- populate_categories(categories)
Populate the layout with categories. Args:
categories (tik_manager4.objects.category.Category): Category object.
- refresh()
Refresh the current category.
- set_category_by_index(category_index)
Set the category by index. Args:
category_index (int): The index of the category.
- set_purgatory_mode(state)
Set the show all state. Args:
state (bool): The state of the show all.
- set_task(task)
Set the task. Args:
task (tik_manager4.object.task.Task): The task object.
- mode_changed
- property purgatory_mode
- Return the purgatory mode.
- class TikCategoryModel
Bases:
tik_manager4.ui.Qt.QtGui.QStandardItemModelCustom QStandardItemModel for the category view.
- append_publish(publish)
Append a publish to the model. Args:
- publish (tik_manager4.object.publish.Publish):
The publish object to be appended to the model.
- Returns:
- TikPublishItem: The item that represents the publish
in the model.
- append_work(work)
Append a work to the model. Args:
- work (tik_manager4.object.work.Work):
The work object to be appended to the model.
- Returns:
- TikWorkItem: The item that represents the work
in the model.
- clear()
Clear the model.
- populate(publishes=False)
Populate the model with the works or publishes. Args:
- publishes (bool, optional): If True, populates the model
with publishes.
- set_publishes(publishes_list)
Set the publishes to the model. Args:
publishes_list (list): A list of publish objects.
- set_works(works_list)
Set the works to the model. Args:
works_list (list): A list of work objects.
- columns = ['name', 'id', 'path', 'creator', 'dcc', 'date', 'version count']
- class TikCategoryView(parent=None)
Bases:
tik_manager4.ui.Qt.QtWidgets.QTreeViewCustom QTreeView for the category view.
- copy_scene_path(item)
Copy the absolute path of the scene file to the clipboard. Args:
- item (TikWorkItem or TikPublishItem):
The work or publish item to be copied.
- currentChanged(*args, **kwargs)
Override the currentChanged method to emit the item_selected signal when an item is clicked. Args:
- delete_item(item)
Delete the given item. Args:
- item (TikWorkItem or TikPublishItem):
The work or publish item to be deleted.
- dragEnterEvent(event)
Override the drag enter event to accept file drops.
- dragMoveEvent(event)
Override the drag move event to accept file drops.
- dropEvent(event)
Override the drop event to accept file drops.
- expandAll()
Expand all the items in the view
- get_column_sizes()
Return all column sizes in a dictionary.
- get_selected_item()
Return the current item
- get_visible_columns()
Return the visible columns.
Create a right click menu for the header. Args:
position (QtCore.QPoint): The position of the right click.
- hide_columns(columns)
Hide the given columns. Args:
columns (str or list): A column name or list of column names to be hidden.
- ingest_here(item)
Send the ingest signal with the given item. Args:
item (TikWorkItem): The work item to be ingested.
- Returns:
None
- item_clicked(idx)
Emit the item_selected signal when an item is clicked. Args:
idx (QtCore.QModelIndex): The index of the clicked item.
- static metadata_pre_checks(dcc_handler, metadata)
Pre-check the metadata method. Args:
- dcc_handler (tik_manager4.dcc_handler.DccHandler):
The DCC handler object.
- metadata (tik_manager4.object.metadata.Metadata):
The metadata object.
- Yields:
str: The message for the pre-check.
- new_version_pre_checks(work_obj, metadata)
Pre-check the new version method. Args:
- work_obj (tik_manager4.object.work.Work):
The work object.
- metadata (tik_manager4.object.metadata.Metadata):
The metadata object.
- Yields:
str: The message for the pre-check.
- omit_item(item)
Omit the given item. Args:
- item (TikWorkItem or TikPublishItem):
The work or publish item to be omitted.
- on_resurrect(item)
Resurrect the given item. Args:
- item (TikWorkItem or TikPublishItem):
The work or publish item to be resurrected.
- open_database_folder(item)
Open the database folder for the given item. Args:
- item (TikWorkItem or TikPublishItem):
The work or publish item to be opened.
- open_scene_folder(item)
Open the scene folder for the given item. Args:
- item (TikWorkItem or TikPublishItem):
The work or publish item to be opened.
- refresh()
Re-populate the model keeping the expanded state.
- revive_item(item)
Revive the given item. Args:
- item (TikWorkItem or TikPublishItem):
The work or publish item to be revived.
Create a right click menu for the view. Args:
position (QtCore.QPoint): The position of the right click.
- select_by_id(unique_id)
Select the item with the given unique id. Args:
unique_id (int): The unique id of the item to be selected.
- Returns:
bool: True if the item is found and selected, False otherwise.
- set_column_sizes(column_sizes)
Set the column sizes from the given dictionary. Args:
column_sizes (dict): A dictionary of column sizes.
- show_columns(list_of_columns)
Show the given columns. Args:
list_of_columns (list): A list of column names to be shown.
- toggle_column(column, state)
Toggle the visibility of the given column. Args:
column (str): The name of the column to be toggled. state (bool): The state of the column visibility.
- unhide_columns(columns)
Unhide the given columns. Args:
columns (str or list): A column name or list of column names to be unhidden.
- export_selection_event
- file_dropped
- import_event
- item_selected
- load_event
- reference_event
- save_new_work_event
- version_created
- work_from_template_event
- work_resurrected
- class TikPublishItem(publish_obj)
Bases:
tik_manager4.ui.Qt.QtGui.QStandardItemCustom QStandardItem for the publish items in the category view.
- dcc_check()
Check if the dcc of the work matches the dcc of the current session.
- refresh()
Refresh the item state.
- set_state(state)
Define the state of the publish item. Args:
- state (str): The state of the publish item.
- Possible values are:
“active”: The work is currently being worked on. “published”: The work is published. “omitted”: The work is omitted. “promoted”: The work is promoted.
Returns:
- state_color_dict
- class TikWorkItem(work_obj)
Bases:
tik_manager4.ui.Qt.QtGui.QStandardItemCustom QStandardItem for the work items in the category view.
- dcc_check()
Check if the dcc of the work matches the dcc of the current session.
- refresh()
Refresh the item state.
- set_state(state)
Define the state of the work item. Args:
- state (str): The state of the work item.
- Possible values are:
“active”: The work is currently being worked on. “published”: The work is published. “omitted”: The work is omitted. “promoted”: The work is promoted.
- state_color_dict