bookmarker.job_editor

Editor widget used by BookmarkerWidget to add and select jobs found inside a server.

The module also defines AddJobWidget, an editor used to create new jobs inside a server.

Parameters:

SECTIONS (dict) – UI definitions used by AddJobWidget.

Classes:

AddJobWidget(server[, parent])	A custom BasePropertyEditor used to add new jobs on a server.
JobContextMenu(index[, parent])	Context menu associated with JobItemEditor.
JobItemEditor([parent])	Simple list widget used to add and remove servers to/from the local common.

Functions:

get_job_icon(path)

Checks the given job folder for the presence of a thumbnail image file.

Data:

SECTIONS

UI layout definition

class bookmarks.bookmarker.job_editor.AddJobWidget(server, parent=None)

Bases: BasePropertyEditor

A custom BasePropertyEditor used to add new jobs on a server.

Methods:

db_source()	A file path to use as the source of database values.
init_data()	Initialize data.
save_changes()	Saves changes.

db_source()

A file path to use as the source of database values.

Returns:

The database source file.

Return type:

str

init_data()

Initialize data.

save_changes()

Saves changes.

class bookmarks.bookmarker.job_editor.JobContextMenu(index, parent=None)

Bases: BaseContextMenu

Context menu associated with JobItemEditor.

Methods:

add_menu()	Add job item action.
refresh_menu()	Refresh job list action.
reveal_menu()	Reveal job item action.
setup()	Creates the context menu.

add_menu()

Add job item action.

refresh_menu()

Refresh job list action.

reveal_menu()

Reveal job item action.

setup()

Creates the context menu.

class bookmarks.bookmarker.job_editor.JobItemEditor(parent=None)

Bases: ListViewWidget

Simple list widget used to add and remove servers to/from the local common.

Methods:

add()	Opens the widget used to create new job items.
contextMenuEvent(event)	Context menu event handler.
init_data(*args, **kwargs)	Load job item data.
item_generator(source[, emit_progress])	Scans the given source, usually a server, to find job items.
keyPressEvent(event)	Key press event handler.
set_filter(v)	Set a search filter.
update_text()	Checks each job item to see if they have active bookmark items, and marks them visually as active.

add()

Opens the widget used to create new job items.

contextMenuEvent(event)

Context menu event handler.

init_data(*args, **kwargs)

Load job item data.

item_generator(source, emit_progress=True)

Scans the given source, usually a server, to find job items.

keyPressEvent(event)

Key press event handler.

set_filter(v)

Set a search filter.

Parameters:

v (str) – The search filter.

update_text()

Checks each job item to see if they have active bookmark items, and marks them visually as active.

bookmarks.bookmarker.job_editor.get_job_icon(path)

Checks the given job folder for the presence of a thumbnail image file.

bookmarks.bookmarker.job_editor.SECTIONS = {0: {'color': PySide2.QtGui.QColor.fromRgbF(0.254902, 0.254902, 0.254902, 1.000000), 'groups': {0: {0: {'description': "The job's name, e.g. `MY_NEW_JOB`.", 'key': None, 'name': 'Name', 'placeholder': 'Name, e.g. `MY_NEW_JOB`', 'validator': <PySide2.QtGui.QRegExpValidator(0x2a201bce0a0)>, 'widget': <class 'bookmarks.ui.LineEdit'>}}, 1: {0: {'description': 'Select a folder template to create this asset.', 'key': None, 'name': 'Template', 'placeholder': None, 'validator': None, 'widget': functools.partial(<class 'bookmarks.templates.TemplatesWidget'>, 'job')}}}, 'icon': '', 'name': 'Add Job'}}

UI layout definition