zim.plugins.trayicon.TrayIconBase

class documentation

class TrayIconBase(object): (source)

Base class for the zim tray icon. Contains code to create the tray icon menus.

Method	`do_activate_notebook`	Open a specific notebook.
Method	`do_open_notebook`	Opens the notebook dialogs
Method	`do_quick_note`	Show the dialog from the quicknote plugin
Method	`do_quit`	Quit zim.
Method	`get_trayicon_menu`	Returns the main 'tray icon menu
Method	`list_all_notebooks`	Returns a list of all notebooks known in the current context
Method	`list_open_notebooks`	Returns a list of open notebook.
Method	`populate_menu_with_notebooks`	Populate a menu with a list of notebooks

def do_activate_notebook(self, uri): (source)

Open a specific notebook.

def do_open_notebook(self): (source)

Opens the notebook dialogs

def do_quick_note(self): (source)

Show the dialog from the quicknote plugin

def do_quit(self): (source)

Quit zim.

def get_trayicon_menu(self): (source)

Returns the main 'tray icon menu

def list_all_notebooks(self): (source)

Returns a list of all notebooks known in the current context

This method mixes notebooks from list_open_notebooks() with input from get_notebook_list(). Open notebooks will have the active attribute set.

Returns
a list of `NotebookInfo` objects

def list_open_notebooks(self): (source)

Returns a list of open notebook.

This method is to be implemented in child classes.

Returns
a list of `NotebookInfo` objects

def populate_menu_with_notebooks(self, menu, notebooks): (source)

Populate a menu with a list of notebooks