zim.plugins.bookmarksbar.BookmarksBarMainWindowExtension

class documentation

class BookmarksBarMainWindowExtension(MainWindowExtension): (source)

Undocumented

Method	`__init__`	Constructor @param plugin: the plugin object to which this extension belongs @param window: the `Gtk.Window` being extended
Method	`add_bookmark`	Function to add new bookmarks to the bar. Introduced to be used via keyboard shortcut.
Method	`bookmark_1`	Undocumented
Method	`bookmark_2`	Undocumented
Method	`bookmark_3`	Undocumented
Method	`bookmark_4`	Undocumented
Method	`bookmark_5`	Undocumented
Method	`bookmark_6`	Undocumented
Method	`bookmark_7`	Undocumented
Method	`bookmark_8`	Undocumented
Method	`bookmark_9`	Undocumented
Method	`hide_widget`	Hide Bar.
Method	`on_populate_popup`	Add 'Add Bookmark' option to the Index popup menu.
Method	`show_widget`	Show Bar.
Method	`teardown`	No summary
Method	`toggle_show_bookmarks`	Show/hide the bar with bookmarks.
Instance Variable	`widget`	Undocumented
Method	`_open_bookmark`	Undocumented

Inherited from MainWindowExtension:

Method	`on_destroy`	Undocumented
Instance Variable	`uistate`	Undocumented
Instance Variable	`window`	Undocumented

Inherited from ActionExtensionBase (via MainWindowExtension):

Method	`add_to_headerbar`	Undocumented
Method	`remove_from_headerbar`	Undocumented
Method	`set_action_in_headerbar`	Undocumented
Instance Variable	`actiongroup`	Undocumented
Static Method	`_uimanager_xml`	Undocumented
Method	`_add_actions`	Undocumented
Instance Variable	`_uimanager`	Undocumented
Instance Variable	`_uimanager_ids`	Undocumented

Inherited from ExtensionBase (via MainWindowExtension, ActionExtensionBase):

Method	`destroy`	Called when the plugin is being destroyed Calls `teardown()` followed by the `teardown()` methods of parent base classes.
Class Variable	`__signals__`	Undocumented
Instance Variable	`obj`	the extendable object
Instance Variable	`plugin`	the plugin object to which this extension belongs

Inherited from SignalEmitter (via MainWindowExtension, ActionExtensionBase, ExtensionBase):

Method	`__new__`	Undocumented
Method	`block_signals`	Returns a context manager for blocking one or more signals
Method	`connect`	Register a handler for a specific object.
Method	`connect_after`	Like `connect()` but handler will be called after default handler
Method	`disconnect`	Undocumented
Method	`emit`	Undocumented
Method	`emit_return_first`	Emits a signal and stops emission on the first handler that returns a not-None value.
Method	`emit_return_iter`	Returns an generator that calls one handler on each iteration and yields the return values. This allows aggregating return values.
Method	`_connect`	Undocumented
Method	`_setup_signal`	Undocumented
Method	`_teardown_signal`	Undocumented

Inherited from ConnectorMixin (via MainWindowExtension, ActionExtensionBase, ExtensionBase):

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, plugin, window): (source)

overrides zim.gui.mainwindow.MainWindowExtension.__init__

Constructor

Parameters
plugin	the plugin object to which this extension belongs
window	the `Gtk.Window` being extended

@action(_('Add Bookmark'), accelerator=BM_ADD_BOOKMARK_KEY, menuhints='page')
def add_bookmark(self): (source)

Function to add new bookmarks to the bar. Introduced to be used via keyboard shortcut.

@action('', accelerator='<alt>1', menuhints='accelonly')
def bookmark_1(self): (source)

Undocumented

@action('', accelerator='<alt>2', menuhints='accelonly')
def bookmark_2(self): (source)

Undocumented

@action('', accelerator='<alt>3', menuhints='accelonly')
def bookmark_3(self): (source)

Undocumented

@action('', accelerator='<alt>4', menuhints='accelonly')
def bookmark_4(self): (source)

Undocumented

@action('', accelerator='<alt>5', menuhints='accelonly')
def bookmark_5(self): (source)

Undocumented

@action('', accelerator='<alt>6', menuhints='accelonly')
def bookmark_6(self): (source)

Undocumented

@action('', accelerator='<alt>7', menuhints='accelonly')
def bookmark_7(self): (source)

Undocumented

@action('', accelerator='<alt>8', menuhints='accelonly')
def bookmark_8(self): (source)

Undocumented

@action('', accelerator='<alt>9', menuhints='accelonly')
def bookmark_9(self): (source)

Undocumented

def hide_widget(self): (source)

Hide Bar.

def on_populate_popup(self, treeview, menu): (source)

Add 'Add Bookmark' option to the Index popup menu.

def show_widget(self): (source)

Show Bar.

def teardown(self): (source)

overrides zim.gui.actionextension.ActionExtensionBase.teardown

Remove changes made by this class from the extended object To be overloaded by child classes

Note
do not call parent class `teardown()` here, that is already taken care of by `destroy()`

@toggle_action(_('Bookmarks'), accelerator=BM_TOGGLE_BAR_KEY, menuhints='view')
def toggle_show_bookmarks(self, active): (source)

Show/hide the bar with bookmarks.

widget = (source)

Undocumented

def _open_bookmark(self, number): (source)

Undocumented