zim.plugins.pageindex.PageTreeView

class documentation

class PageTreeView(BrowserTreeView): (source)

Known subclasses: zim.plugins.tags.TagsPageTreeView

View In Hierarchy

TreeView widget to show a list of pages.

This view is intended to show a PageTreeStore model, but it can also handle filtered models and subclasses that have the same columns. (The "tags" plugin uses this same view with alternative models.)

Unknown Field: signal
page-activated (path): emitted when a page is clicked
populate-popup (menu): hook to populate the context menu
copy (): copy the current selection to the clipboard
insert-link (path): called when the user pressed <Ctrl>L on page
Method __init__ Constructor, all arguments are passed to Gtk.TreeView
Method disconnect_index No summary
Method do_drag_data_get Undocumented
Method do_drag_data_received Undocumented
Method do_initialize_popup No summary
Method do_key_press_event Undocumented
Method do_page_activated Undocumented
Method do_row_activated Undocumented
Method get_expanded_path Return the lowest expanded path towards path
Method get_selected_path Get the selected notebook path
Method get_selected_treepath Undocumented
Method restore_autoexpanded_path Undocumented
Method select_treepath Select a gtk TreePath in the view
Method set_autoexpand Undocumented
Method set_current_page Select a page in the treeview
Method set_use_drag_and_drop Undocumented
Method set_use_ellipsize Set whether to use ellipsize ("...") for page names that are longer than the window size. If disabled the horizontal scrollbar will take over
Method set_use_tooltip Undocumented
Class Variable __gsignals__ Undocumented
Instance Variable navigation Undocumented
Instance Variable notebook Undocumented
Method _restore_expanded_path Collaps path between path and expanded_path
Method _store_expanded_path Undocumented
Instance Variable _autocollapse Undocumented
Instance Variable _autoexpand Undocumented
Instance Variable _autoexpanded Undocumented
Instance Variable _cr1 Undocumented

Inherited from SingleClickTreeView (via BrowserTreeView):

Method do_button_press_event Undocumented
Method do_button_release_event Undocumented
Method get_cell_renderer_number_of_items No summary
Method get_popup No summary
Method populate_popup_expand_collapse No summary
Class Variable mask Undocumented
def __init__(self, notebook, navigation, model=None): (source)
overrides zim.gui.widgets.BrowserTreeView.__init__
Constructor, all arguments are passed to Gtk.TreeView
def disconnect_index(self): (source)
Stop the widget from listening to the index. Used e.g. to unhook the model before reloading the index, thus avoiding many signals to be processed by both the model and the view. Doing this requires constructing and setting a new model with set_model() to get the view in sync with the index again.
def do_drag_data_get(self, dragcontext, selectiondata, info, time): (source)

Undocumented

def do_drag_data_received(self, dragcontext, x, y, selectiondata, info, time): (source)

Undocumented

def do_initialize_popup(self, menu): (source)
overrides zim.gui.widgets.SingleClickTreeView.do_initialize_popup
Initialize the context menu. This method is called before the populate-popup signal and can be used to put any standard items in the menu.
Parameters
menuthe Gtk.Menu object for the popup
Unknown Field: implementation
can be implemented by sub-classes. Default implementation calls populate_popup_expand_collapse() if the model is a Gtk.TreeStore. Otherwise it does nothing.
def do_key_press_event(self, event): (source)
overrides zim.gui.widgets.BrowserTreeView.do_key_press_event

Undocumented

def do_page_activated(self, path): (source)

Undocumented

def do_row_activated(self, treepath, column): (source)

Undocumented

def get_expanded_path(self, path): (source)
Return the lowest expanded path towards path
def get_selected_path(self): (source)
Get the selected notebook path
Returns
a PageIndexRecord or None if there was no selection
def get_selected_treepath(self): (source)

Undocumented

def restore_autoexpanded_path(self): (source)

Undocumented

def select_treepath(self, treepath): (source)
Select a gtk TreePath in the view
Parameters
treepatha gtk TreePath (tuple of integers)
def set_autoexpand(self, autoexpand, autocollapse): (source)

Undocumented

def set_current_page(self, path, vivificate=False): (source)
overridden in zim.plugins.tags.TagsPageTreeView
Select a page in the treeview
Parameters
patha notebook Path object for the page
vivificatewhen True the path is created temporarily when it did not yet exist
Returns
a gtk TreePath (tuple of intergers) or None
def set_use_drag_and_drop(self, use_drag_and_drop): (source)

Undocumented

def set_use_ellipsize(self, use_ellipsize): (source)
Set whether to use ellipsize ("...") for page names that are longer than the window size. If disabled the horizontal scrollbar will take over
def set_use_tooltip(self, use_tooltip): (source)

Undocumented

__gsignals__ = (source)
overrides zim.gui.widgets.SingleClickTreeView.__gsignals__

Undocumented

navigation = (source)

Undocumented

notebook = (source)

Undocumented

def _restore_expanded_path(self, path, expanded_path): (source)
Collaps path between path and expanded_path
def _store_expanded_path(self, path): (source)

Undocumented

_autocollapse = (source)

Undocumented

_autoexpand = (source)

Undocumented

_autoexpanded = (source)

Undocumented

_cr1 = (source)

Undocumented