common#
Core attributes, classes and methods used to define the look and behaviour of Bookmarks.
See the setup module for the initialization methods.
Hard-coded default properties are defined in core.
Configurable properties, such as colors and size settings are loaded from
./rsc/conf.json at runtime.
Tip
Submodules can be accessed directly from this top module. E.g.:
1# bookmarks.common.setup.initialize(common.EmbeddedMode) can be imported as
2from bookmarks import common
3common.initialize(common.EmbeddedMode)
The app can be run in two modes. As a standalone application, or embedded in a PySide2 environment. The base-layers can be initialized with:
1from bookmarks import common
2common.initialize(common.EmbeddedMode) # or common.StandaloneMode
bookmarks.exec_() is a utility method for starting Bookmarks in
StandaloneMode, whilst EmbeddedMode is useful when
running from inside a host DCC. Currently only the Maya plugin makes use of this mode.
See bookmarks.maya and bookmarks.common for the related methods.
- common.core
DataDictTimeradd_link()byte_to_pretty_string()check_type()debug()error()get_entry_from_path()get_hash()get_links()get_platform()get_py_obj_size()get_sequence_and_shot()get_template_file_path()get_thread_key()get_username()int_key()is_dir()pseudo_local_bookmark()rsc()sort_words()temp_path()CONFIGEmbeddedModeStandaloneMode
- common.data
- common.env
- common.font
- common.monitor
- common.sequence
- common.session_lock
- common.settings
- common.setup
- common.signals
CoreSignalsCoreSignals.activeModeChangedCoreSignals.assetActivatedCoreSignals.assetAddedCoreSignals.bookmarkActivatedCoreSignals.bookmarkAddedCoreSignals.bookmarkRemovedCoreSignals.bookmarksChangedCoreSignals.clearStatusBarMessageCoreSignals.databaseValueUpdatedCoreSignals.favouriteAddedCoreSignals.favouriteRemovedCoreSignals.favouritesChangedCoreSignals.fileActivatedCoreSignals.fileAddedCoreSignals.generateThumbnailsChangedCoreSignals.itemArchivedCoreSignals.itemUnarchivedCoreSignals.jobAddedCoreSignals.paintThumbnailBGChangedCoreSignals.serverAddedCoreSignals.serverRemovedCoreSignals.serversChangedCoreSignals.sgAssetsLinkedCoreSignals.sgConnectionAttemptStartedCoreSignals.sgConnectionClosedCoreSignals.sgConnectionFailedCoreSignals.sgConnectionSuccessfulCoreSignals.sgEntityDataReadyCoreSignals.sgEntitySelectedCoreSignals.showStatusBarMessageCoreSignals.showStatusTipMessageCoreSignals.tabChangedCoreSignals.taskFolderChangedCoreSignals.taskViewToggledCoreSignals.templateExpandedCoreSignals.templatesChangedCoreSignals.threadItemsQueuedCoreSignals.thumbnailUpdatedCoreSignals.toggleArchivedButtonCoreSignals.toggleFavouritesButtonCoreSignals.toggleFilterButtonCoreSignals.toggleInlineIconsCoreSignals.toggleSequenceButtonCoreSignals.updateTopBarButtons
init_signals()
- common.ui
active_index()center_window()color()current_tab()draw_aliased_text()fit_screen_geometry()get_selected_index()init_stylesheet()model()move_widget_to_available_geo()restore_selection()restore_window_geometry()restore_window_state()rgb()save_selection()save_window_state()select_index()selected_index()set_stylesheet()size()source_model()status_bar_message()widget()