class documentation

class NotebookTreeModel(Gtk.ListStore): (source)

View In Hierarchy

TreeModel that wraps a notebook list
Note
To refer to the notebook in an unambiguous way, use the uri stored in the NotebookInfo object.
Unknown Field: column
OPEN_COL: boolean, True if the notebook is opened already
NAME_COL: string, name of the notebook
TEXT_COL: string, formatted string containg the name and path
PIXBUF_COL: GdkPixbuf.Pixbuf, the icon of the notebook (if any)
INFO_COL: NotebookInfo object
Method __init__ Constructor. If "notebooklist" is None, the default list as provided by zim.notebook.get_notebook_list() is used.
Method append_notebook Append a notebook to the list. If the name is not specified it will be looked up by reading the config file of the notebook. Returns an iter for this notebook in the list.
Method get_iter_for_default Returns a TreeIter for the default notebook or None
Method get_iter_for_notebook Returns the TreeIter for a notebook path or None
Method set_default_from_iter Set the default notebook using a TreeIter, set to None to reset the default.
Method write Save the notebook list.
Instance Variable notebooklist Undocumented
Method _append Undocumented
Instance Variable _loading Undocumented
def __init__(self, notebooklist=None): (source)
Constructor. If "notebooklist" is None, the default list as provided by zim.notebook.get_notebook_list() is used.
Parameters
notebooklista list of NotebookInfo objects
def append_notebook(self, uri, name=None): (source)
Append a notebook to the list. If the name is not specified it will be looked up by reading the config file of the notebook. Returns an iter for this notebook in the list.
def get_iter_for_default(self): (source)
Returns a TreeIter for the default notebook or None
def get_iter_for_notebook(self, uri): (source)
Returns the TreeIter for a notebook path or None
def set_default_from_iter(self, iter): (source)
Set the default notebook using a TreeIter, set to None to reset the default.
def write(self): (source)
Save the notebook list.
notebooklist = (source)

Undocumented

def _append(self, info): (source)

Undocumented

_loading: bool = (source)

Undocumented