editor.preferences#

PreferenceEditor and helper classes used to set application-wide preferences.

Classes:

PreferenceEditor([parent])

Property editor used to edit application preferences.

UIScaleFactorsCombobox([parent])

Editor used to pick a ui scale value.

Functions:

close()

Closes the PreferenceEditor widget.

show()

Shows the PreferenceEditor widget.

Data:

SECTIONS

UI layout definition

class bookmarks.editor.preferences.PreferenceEditor(parent=None)[source]#

Bases: BasePropertyEditor

Property editor used to edit application preferences.

Methods:

app_version_button_clicked(*args, **kwargs)

Info button click action.

db_source()

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

help_button_clicked(*args, **kwargs)

Info button click action.

init_data(*args, **kwargs)

Initializes data.

save_changes()

Saves changes.

app_version_button_clicked(*args, **kwargs)[source]#

Info button click action.

db_source()[source]#

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

Returns

The database source file.

Return type

str

help_button_clicked(*args, **kwargs)[source]#

Info button click action.

init_data(*args, **kwargs)[source]#

Initializes data.

save_changes()[source]#

Saves changes.

class bookmarks.editor.preferences.UIScaleFactorsCombobox(parent=None)[source]#

Bases: QComboBox

Editor used to pick a ui scale value.

Methods:

init_data()

Initializes data.

init_data()[source]#

Initializes data.

bookmarks.editor.preferences.close()[source]#

Closes the PreferenceEditor widget.

bookmarks.editor.preferences.show()[source]#

Shows the PreferenceEditor widget.

bookmarks.editor.preferences.SECTIONS = {0: {'color': None, 'groups': {0: {0: {'description': "Scales Bookmark's interface by the specified amount.\nUseful for high-dpi displays if the text is too small to read.\n\nTakes effect the next time Bookmarks is launched.", 'key': 'settings/ui_scale', 'name': 'Interface Scale', 'placeholder': '', 'validator': None, 'widget': <class 'bookmarks.editor.preferences.UIScaleFactorsCombobox'>}, 1: {'description': 'Check to icons', 'key': 'settings/show_menu_icons', 'name': 'Hide Context Menu Icons', 'placeholder': 'Check to icons', 'validator': None, 'widget': functools.partial(<class 'PySide2.QtWidgets.QCheckBox'>, 'Enable')}, 2: {'description': 'Check to hide thumbnail background colors', 'key': 'settings/paint_thumbnail_bg', 'name': 'Hide Thumbnail Backgrounds', 'placeholder': 'Check to hide thumbnail background colors', 'validator': None, 'widget': functools.partial(<class 'PySide2.QtWidgets.QCheckBox'>, 'Enable')}, 3: {'description': 'Check to disable generating thumbnails from image files using OpenImageIO', 'key': 'settings/disable_oiio', 'name': 'Disable Image Thumbnails', 'placeholder': 'Check to disable generating thumbnails from image files using OpenImageIO', 'validator': None, 'widget': functools.partial(<class 'PySide2.QtWidgets.QCheckBox'>, 'Disable')}}, 1: {0: {'description': 'In case your job folder uses a client/project like structure, tick this box. Leave it un-ticked if the project folders are nested directly in the serverfolder.', 'help': 'Enable if jobs have separate <span style="color:white">client/project</span> folders. By default, Bookmarks assumes jobs are kept directly in the root of the server folder but you can override this here.', 'key': 'settings/jobs_have_clients', 'name': 'Jobs have clients', 'placeholder': '', 'validator': None, 'widget': functools.partial(<class 'PySide2.QtWidgets.QCheckBox'>, 'Enable')}, 1: {'description': 'Set the maximum folder depth to parse. Parsing large project folders will take a long time. This setting will limit the number of sub-directories the editor parses when looking for bookmark items.', 'help': 'This setting will limit the number of sub-directories the editor will look into when looking for bookmark items.', 'key': 'settings/job_scan_depth', 'name': 'Bookmark item search depth', 'placeholder': '3', 'validator': <PySide2.QtGui.QRegExpValidator(0x26177cf0a60)>, 'widget': <class 'bookmarks.ui.LineEdit'>}}}, 'icon': 'icon', 'name': 'Interface'}, 2: {'color': None, 'groups': {0: {0: {'description': 'Edit external binary paths', 'key': 'environment', 'name': None, 'placeholder': '', 'validator': None, 'widget': <class 'bookmarks.common.env.EnvPathEditor'>}}}, 'icon': 'icon', 'name': 'Binaries'}, 3: {'color': None, 'groups': {0: {0: {'description': 'Click to disable setting the Maya workspace. By default the Maya workspace is always set to be thecurrent active asset.', 'key': 'maya/sync_workspace', 'name': 'Set Maya Workspace', 'placeholder': None, 'validator': None, 'widget': functools.partial(<class 'PySide2.QtWidgets.QCheckBox'>, 'Disable')}}, 1: {0: {'description': 'Click to disable warnings when saving files outside the current Workspace.', 'key': 'maya/workspace_save_warnings', 'name': 'Workspace Save Warning', 'placeholder': None, 'validator': None, 'widget': functools.partial(<class 'PySide2.QtWidgets.QCheckBox'>, 'Disable')}}, 2: {0: {'description': 'When ShotGrid RV is available the latest capture will automatically be pushed to RV for viewing. Check the box above to disable.', 'key': 'maya/push_capture_to_rv', 'name': 'Push Capture to RV', 'placeholder': None, 'validator': None, 'widget': functools.partial(<class 'PySide2.QtWidgets.QCheckBox'>, 'Disable')}, 1: {'description': 'Check the box above to disable showing captures in the file explorer.', 'key': 'maya/reveal_capture', 'name': 'Reveal Capture', 'placeholder': None, 'validator': None, 'widget': functools.partial(<class 'PySide2.QtWidgets.QCheckBox'>, 'Disable')}, 2: {'description': 'The last capture by default will be published into a "Latest" folder with using a generic filename.\nThis can be useful for creating quick edits in RV. Check the box above to disable.', 'key': 'maya/publish_capture', 'name': 'Disable "Latest" Capture', 'placeholder': None, 'validator': None, 'widget': functools.partial(<class 'PySide2.QtWidgets.QCheckBox'>, 'Disable')}}}, 'icon': 'maya', 'name': 'Maya'}, 4: {'color': PySide2.QtGui.QColor.fromRgbF(0.686275, 0.686275, 0.686275, 1.000000), 'groups': {0: {0: {'button': 'Open Documentation', 'description': 'Show the online documentation', 'key': None, 'name': 'Help', 'placeholder': '', 'validator': None, 'widget': None}, 1: {'button': 'Check for Updates', 'description': 'Check online for new versions.', 'key': 'app_version', 'name': 'Latest Version', 'placeholder': '', 'validator': None, 'widget': None}}, 1: {0: {'description': '', 'help': 'Copyright (c) 2022 Gergely Wootsch\nE-Mail: hello@gergely-wootsch.com\nWebsite: https://bookmarks-vfx.com\n\nPackages\nPython 3.9.7 MSC v.1929 64 bit (AMD64)\nBookmarks 0.7.5\nPySide2 5.15.2\nOpenImageIO 2.3.19\nShotGrid API 3.3.4\nSlack SDK 3.18.3', 'key': None, 'name': 'Current Versions', 'placeholder': '', 'validator': None, 'widget': None}}, 2: {0: {'description': 'Enable debug messages.', 'key': None, 'name': 'Debugging', 'placeholder': '', 'validator': None, 'widget': functools.partial(<class 'PySide2.QtWidgets.QCheckBox'>, 'Enable')}, 1: {'button': 'Reset Image Cache', 'description': '', 'key': 'reset_image_cache', 'name': '', 'placeholder': '', 'validator': None, 'widget': None}, 2: {'button': 'Reset Database Connections', 'description': '', 'key': 'reset_databases', 'name': '', 'placeholder': '', 'validator': None, 'widget': None}}}, 'icon': None, 'name': 'About'}}#

UI layout definition