zim.plugins.bookmarksbar.BookmarkBar

class documentation

class BookmarkBar(Gtk.HBox, ConnectorMixin): (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method add_new_page Add new page as bookmark to the bar. :param page: Page, if None takes currently opened page,
Method change_bookmark Change path in bookmark from 'old_path' to 'new_path'. :param new_path, old_path: strings corresponding to Path.name. If 'new_path' == None takes currently opened page.
Method delete Remove one button from the bar. :param path: string corresponding to Path.name.
Method delete_all Remove all bookmarks. :param ask_confirmation: to confirm deleting.
Method do_bookmarks_popup_menu Handler for button-release-event, triggers popup menu for bookmarks.
Method do_plus_button_popup_menu Handler for button-release-event, triggers popup menu for plus button.
Method move_bookmark Move bookmark 'first' to the place near the bookmark 'second'. :param first, second: strings corresponding to Path.name. :param direction: move 'first' bookmark to the 'left' or 'right' of the 'second'.
Method on_bookmark_clicked Open page if a bookmark is clicked.
Method on_preferences_changed Plugin preferences were changed.
Method rename_bookmark No summary
Method set_page If a page is present as a bookmark than select it.
Method toggle_show_full_page_name Change page name from short to full and vice versa.
Instance Variable add_bookmarks_to_beginning Undocumented
Instance Variable max_bookmarks Undocumented
Instance Variable navigation Undocumented
Instance Variable notebook Undocumented
Instance Variable paths Undocumented
Instance Variable paths_names Undocumented
Instance Variable plus_button Undocumented
Instance Variable save_flag Undocumented
Instance Variable scrolledbox Undocumented
Instance Variable uistate Undocumented
Method _add_new No summary
Method _get_short_page_name Function to return short name for the page. Is used to set short names to bookmarks.
Method _reload_bar Reload bar with bookmarks.
Instance Variable _convert_path_name Undocumented
Instance Variable _get_page Undocumented
Instance Variable _saved_bookmark Undocumented

Inherited from ConnectorMixin:

Method connectto Connect to signals of another object E.g.:
Method connectto_all Convenience method to combine multiple calls to connectto().
Method disconnect_all Disconnect all signals that have been connected with connectto and friends. Typically called when you want to destroy this object.
Method disconnect_from Disc all signals that have been connected with connectto and friends to a specific object.
Method _disconnect_from Undocumented
Instance Variable _connected_signals Undocumented
def __init__(self, notebook, navigation, uistate, get_page_func): (source)

Undocumented

def add_new_page(self, page=None): (source)
Add new page as bookmark to the bar. :param page: Page, if None takes currently opened page,
def change_bookmark(self, old_path, new_path=None): (source)
Change path in bookmark from 'old_path' to 'new_path'. :param new_path, old_path: strings corresponding to Path.name. If 'new_path' == None takes currently opened page.
def delete(self, path): (source)
Remove one button from the bar. :param path: string corresponding to Path.name.
def delete_all(self, ask_confirmation=False): (source)
Remove all bookmarks. :param ask_confirmation: to confirm deleting.
def do_bookmarks_popup_menu(self, button, event): (source)
Handler for button-release-event, triggers popup menu for bookmarks.
def do_plus_button_popup_menu(self, button, event): (source)
Handler for button-release-event, triggers popup menu for plus button.
def move_bookmark(self, first, second, direction): (source)
Move bookmark 'first' to the place near the bookmark 'second'. :param first, second: strings corresponding to Path.name. :param direction: move 'first' bookmark to the 'left' or 'right' of the 'second'.
@SignalHandler
def on_bookmark_clicked(self, button): (source)
Open page if a bookmark is clicked.
def on_preferences_changed(self, preferences): (source)
Plugin preferences were changed.
def rename_bookmark(self, button): (source)
Change label of the button. New name is taken from the clipboard. If button's name has been changed before, change it back to its initial state.
def set_page(self, page): (source)
If a page is present as a bookmark than select it.
def toggle_show_full_page_name(self): (source)
Change page name from short to full and vice versa.
add_bookmarks_to_beginning = (source)

Undocumented

max_bookmarks = (source)

Undocumented

navigation = (source)

Undocumented

notebook = (source)

Undocumented

paths: list = (source)

Undocumented

paths_names: dict = (source)

Undocumented

plus_button = (source)

Undocumented

save_flag = (source)

Undocumented

scrolledbox = (source)

Undocumented

uistate = (source)

Undocumented

def _add_new(self, path, add_bookmarks_to_beginning=False): (source)
Add bookmark to the bar. :param path: path as a string object :param add_bookmarks_to_beginning: bool, add new bookmarks to the beginning of the bar,
def _get_short_page_name(self, name): (source)
Function to return short name for the page. Is used to set short names to bookmarks.
def _reload_bar(self): (source)
Reload bar with bookmarks.
_convert_path_name = (source)

Undocumented

_get_page = (source)

Undocumented

_saved_bookmark = (source)

Undocumented