zim.notebook.index.pages.PagesTreeModelMixin

class documentation

class PagesTreeModelMixin(TreeModelMixinBase): (source)

Known subclasses: zim.notebook.index.tags.TagsTreeModelBase, zim.plugins.pageindex.PageTreeStore

Undocumented

Method	`__init__`	Undocumented
Method	`connect_to_updateiter`	Connect to a new `IndexUpdateIter`
Method	`find`	Returns the `Gtk.TreePath` for a notebook page `Path` If the `Path` appears multiple times returns the first occurrence @raises IndexNotFoundError: if path not found
Method	`find_all`	Returns a list of `Gtk.TreePath` for a notebook page `Path` Returns all occurrences in the treeview @raises IndexNotFoundError: if path not found
Method	`get_mytreeiter`	Returns a `treeiter` object for `treepath` or `None` @implementation: must be implemented by a subclass
Method	`n_children_top`	Return the number of items in the top level of the model
Method	`on_page_row_changed`	Undocumented
Method	`on_page_row_delete`	Undocumented
Method	`on_page_row_deleted`	Undocumented
Method	`on_page_row_inserted`	Undocumented
Method	`_check_parent_has_child_toggled`	Undocumented
Method	`_find_all_pages`	Undocumented
Method	`_set_root_id`	Undocumented
Instance Variable	`_deleted_paths`	Undocumented
Instance Variable	`_MY_ROOT_ID`	Undocumented
Instance Variable	`_MY_ROOT_NAME`	Undocumented
Instance Variable	`_MY_ROOT_NAME_C`	Undocumented
Instance Variable	`_REVERSE`	Undocumented

Inherited from TreeModelMixinBase:

Method	`teardown`	Undocumented
Instance Variable	`cache`	Undocumented
Instance Variable	`db`	Undocumented
Instance Variable	`index`	Undocumented

Inherited from ConnectorMixin (via TreeModelMixinBase):

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, index, root=None, reverse=False): (source)

overrides zim.notebook.index.base.TreeModelMixinBase.__init__

overridden in zim.notebook.index.tags.TagsTreeModelBase, zim.plugins.pageindex.PageTreeStore

Undocumented

def connect_to_updateiter(self, index, update_iter): (source)

overrides zim.notebook.index.base.TreeModelMixinBase.connect_to_updateiter

overridden in zim.notebook.index.tags.TagsTreeModelBase

Connect to a new IndexUpdateIter

The following signals must be implemented:

row-inserted (treepath, treeiter)
row-changed (treepath, treeiter)
row-has-child-toggled (treepath, treeiter)
row-deleted (treepath)

Typically each signal should also flush the cache using self.cache.clear().

Unknown Field: implementation
must be implemented by a subclass

def find(self, path): (source)

overrides zim.notebook.index.base.TreeModelMixinBase.find

overridden in zim.notebook.index.tags.TagsTreeModelMixin

Returns the Gtk.TreePath for a notebook page Path If the Path appears multiple times returns the first occurrence

Raises
`IndexNotFoundError`	if path not found

def find_all(self, path): (source)

overrides zim.notebook.index.base.TreeModelMixinBase.find_all

overridden in zim.notebook.index.tags.TagsTreeModelMixin

Returns a list of Gtk.TreePath for a notebook page Path Returns all occurrences in the treeview

Raises
`IndexNotFoundError`	if path not found

def get_mytreeiter(self, treepath): (source)

overrides zim.notebook.index.base.TreeModelMixinBase.get_mytreeiter

overridden in zim.notebook.index.tags.TaggedPagesTreeModelMixin, zim.notebook.index.tags.TagsTreeModelMixin

Returns a treeiter object for treepath or None

Unknown Field: implementation
must be implemented by a subclass

def n_children_top(self): (source)

overrides zim.notebook.index.base.TreeModelMixinBase.n_children_top

overridden in zim.notebook.index.tags.TaggedPagesTreeModelMixin

Return the number of items in the top level of the model

def on_page_row_changed(self, o, row, oldrow): (source)

Undocumented

def on_page_row_delete(self, o, row): (source)

Undocumented

def on_page_row_deleted(self, o, row): (source)

Undocumented

def on_page_row_inserted(self, o, row): (source)

Undocumented

def _check_parent_has_child_toggled(self, treepath, count): (source)

Undocumented

def _find_all_pages(self, name, update_cache=True): (source)

overridden in zim.notebook.index.tags.TaggedPagesTreeModelMixin, zim.notebook.index.tags.TagsTreeModelMixin

Undocumented

def _set_root_id(self): (source)

Undocumented

_deleted_paths = (source)

Undocumented

_MY_ROOT_ID = (source)

Undocumented

_MY_ROOT_NAME = (source)

Undocumented

_MY_ROOT_NAME_C = (source)

Undocumented

_REVERSE = (source)

Undocumented