class documentation

class TaggedPageTreeStore(TaggedPagesTreeModelMixin, DuplicatePageTreeStore): (source)

View In Hierarchy

A TreeModel that lists all Zim pages in a flat list. Pages with associated sub-pages still show them as sub-nodes. Intended to be filtered by tags.
Method __init__ Initialize. Make sure to call this from derived classes if overridden.
Method on_get_value Returns the data for a specific column
Instance Variable show_full_page_name Undocumented

Inherited from TaggedPagesTreeModelMixin:

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_tag_added_to_page Undocumented
Method on_tag_remove_from_page Undocumented
Method _find_all_pages Undocumented
Method _matches_all Undocumented
Instance Variable _deleted_tag_path Undocumented

Inherited from TagsTreeModelBase (via TaggedPagesTreeModelMixin):

Method connect_to_updateiter Connect to a new IndexUpdateIter
Method on_tag_removed_from_page Undocumented
Method on_tag_row_deleted Undocumented
Method on_tag_row_inserted Undocumented
Instance Variable tags Undocumented
Method _emit_children_inserted Undocumented
Method _update_ids Undocumented
Instance Variable _tagids Undocumented
Instance Variable _tagquery Undocumented

Inherited from PagesTreeModelMixin (via TaggedPagesTreeModelMixin, TagsTreeModelBase):

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 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 _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 (via TaggedPagesTreeModelMixin, TagsTreeModelBase, PagesTreeModelMixin):

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

Inherited from ConnectorMixin (via TaggedPagesTreeModelMixin, TagsTreeModelBase, PagesTreeModelMixin, 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

Inherited from DuplicatePageTreeStore:

Method get_indexpath Get an PageIndexRecord for a Gtk.TreeIter
Method set_current_page Since there may be duplicates of each page, highlight all of them
Instance Variable current_page Undocumented

Inherited from PageTreeStoreBase (via DuplicatePageTreeStore):

Method flush_cache Undocumented
Method on_get_column_type Overridable.
Method on_get_flags Overridable.
Method on_get_iter Returns an MyTreeIter for a gtk TreePath or None
Method on_get_n_columns Overridable.
Method on_get_path Returns a gtk TreePath for an indexpath
Method on_iter_children Returns an PageIndexRecord for the first child below path or None. If path is None returns the PageIndexRecord for first top level item.
Method on_iter_has_child Returns True if PageIndexRecord for iter has children
Method on_iter_n_children Returns the number of children in a namespace. When iter is None the number of pages in the root namespace is given.
Method on_iter_next Returns the PageIndexRecord for the next row on the same level or None
Method on_iter_nth_child Returns the nth child or None. If iter is None the nth item in the root namespace is returned.
Method on_iter_parent Returns an indexpath for parent node or None
Constant COLUMN_TYPES Undocumented
Method _emit_page_changes Undocumented
Instance Variable _flush_scheduled Undocumented

Inherited from GenericTreeModel (via DuplicatePageTreeStore, PageTreeStoreBase):

Method create_tree_iter Create a Gtk.TreeIter instance with the given user_data specific for this model.
Method do_get_column_type Internal method.
Method do_get_flags Internal method.
Method do_get_iter Internal method.
Method do_get_n_columns Internal method.
Method do_get_path Internal method.
Method do_get_value Internal method.
Method do_iter_children Internal method.
Method do_iter_has_child Internal method.
Method do_iter_n_children Internal method.
Method do_iter_next Internal method.
Method do_iter_nth_child Internal method.
Method do_iter_parent Internal method.
Method do_ref_node Undocumented
Method do_unref_node Undocumented
Method get_user_data Get the user_data associated with the given TreeIter.
Method invalidate_iter Clear user data and its reference from the iter and this model.
Method invalidate_iters This method invalidates all TreeIter objects associated with this custom tree model and frees their locally pooled references.
Method iter_depth_first Depth-first iteration of the entire TreeModel yielding the python nodes.
Method iter_is_valid :Returns: True if the gtk.TreeIter specified by iter is valid for the custom tree model.
Method on_ref_node Undocumented
Method on_unref_node Undocumented
Method row_deleted Notify the model a row has been deleted.
Method set_user_data Applies user_data and stamp to the given iter.
Class Variable leak_references Undocumented
Instance Variable stamp Undocumented
Method _create_tree_iter Internal creation of a (bool, TreeIter) pair for returning directly back to the view interfacing with this model.
Instance Variable _held_refs Undocumented
def __init__(self, index, tags, show_full_page_name=True): (source)
Initialize. Make sure to call this from derived classes if overridden.
def on_get_value(self, iter, column): (source)
Returns the data for a specific column
show_full_page_name = (source)

Undocumented