bookmarker.bookmark_editor

Editor widget used by BookmarkerWidget to save bookmark items to the user settings file.

Classes:

BookmarkEditorContextMenu(index[, parent])	Context menu associated with BookmarkItemEditor.
BookmarkItemEditor([parent])	List widget containing a job's available bookmark items.

class bookmarks.bookmarker.bookmark_editor.BookmarkEditorContextMenu(index, parent=None)

Bases: BaseContextMenu

Context menu associated with BookmarkItemEditor.

Methods:

add_menu()	Add bookmark item action.
bookmark_properties_menu()	Show the bookmark item property editor.
copy_json_menu()	Copy bookmark item as JSON action.
refresh_menu()	Refresh bookmark item list action.
reveal_menu()	Reveal bookmark item action.
setup()	Creates the context menu.

add_menu()

Add bookmark item action.

bookmark_properties_menu()

Show the bookmark item property editor.

copy_json_menu()

Copy bookmark item as JSON action.

refresh_menu()

Refresh bookmark item list action.

reveal_menu()

Reveal bookmark item action.

setup()

Creates the context menu.

class bookmarks.bookmarker.bookmark_editor.BookmarkItemEditor(parent=None)

Bases: ListWidget

List widget containing a job’s available bookmark items.

Methods:

add(*args, **kwargs)	Pick and add a folder as a new bookmark item.
add_remove_bookmark(state, v)	Slot used to add or remove a bookmark item.
contextMenuEvent(event)	Context menu event.
init_data()	Initializes data.
item_generator(path[, recursion, max_recursion])	Recursive scanning function for finding bookmark folders inside the given path.
keyPressEvent(event)	Key press event handler.
toggle_item_state(item)	Slot used to toggle the check state of an item.
update_state(item)	Checks if the item is part of the current bookmark set and sets the item's check state and icon accordingly.

add(*args, **kwargs)

Pick and add a folder as a new bookmark item.

add_remove_bookmark(state, v)

Slot used to add or remove a bookmark item.

Parameters:

• state (QtCore.Qt.CheckState) – A check state.

• v (QtWidgets.QListWidgetItem) – The item that was just toggled.

contextMenuEvent(event)

Context menu event.

init_data()

Initializes data.

item_generator(path, recursion=0, max_recursion=3)

Recursive scanning function for finding bookmark folders inside the given path.

keyPressEvent(event)

Key press event handler.

toggle_item_state(item)

Slot used to toggle the check state of an item.

update_state(item)

Checks if the item is part of the current bookmark set and sets the item’s check state and icon accordingly.

Parameters:

item (QtWidgets.QListWidgetItem) – The item to verify.