zim.gui.mainwindow.MainWindow

class documentation

class MainWindow(WindowBaseMixin, Window): (source)

Undocumented

Method	`__init__`	No summary
Method	`close`	Menu action for close. Will hide when `hideonclose` is set, otherwise destroys window, which could result in the application closing if there are no other toplevel windows.
Method	`destroy`	Undocumented
Method	`do_button_press_event`	Undocumented
Method	`do_page_changed`	Undocumented
Method	`do_page_info_changed`	Undocumented
Method	`do_preferences_changed`	Undocumented
Method	`init_uistate`	Undocumented
Method	`on_notebook_properties_changed`	Undocumented
Method	`on_window_state_event`	Undocumented
Method	`open_page`	Method to open a page in the mainwindow, and menu action for the "jump to" menu item.
Method	`open_page_back`	Menu action to open the previous page from the history @returns: `True` if successfull
Method	`open_page_child`	Menu action to open a child page. Either takes the last child from the history, or the first child. @returns: `True` if successfull
Method	`open_page_forward`	Menu action to open the next page from the history @returns: `True` if successfull
Method	`open_page_home`	Menu action to open the home page
Method	`open_page_next`	Menu action to open the next page from the index @returns: `True` if successfull
Method	`open_page_parent`	Menu action to open the parent page @returns: `True` if successful
Method	`open_page_previous`	Menu action to open the previous page from the index @returns: `True` if successfull
Method	`save_uistate`	Undocumented
Method	`show_jump_to`	Undocumented
Method	`toggle_menubar`	Menu action to toggle the visibility of the menu bar @param show: when `True` or `False` force the visibility, when `None` toggle based on current state
Method	`update_buttons_hierarchy`	Undocumented
Method	`update_buttons_history`	Undocumented
Class Variable	`__gsignals__`	Undocumented
Instance Variable	`hideonclose`	Undocumented
Instance Variable	`history`	Undocumented
Instance Variable	`isfullscreen`	Undocumented
Instance Variable	`maximized`	Undocumented
Instance Variable	`menubar`	Undocumented
Instance Variable	`navigation`	Undocumented
Instance Variable	`notebook`	Undocumented
Instance Variable	`page`	Undocumented
Instance Variable	`pageview`	Undocumented
Instance Variable	`preferences`	Undocumented
Instance Variable	`uimanager`	Undocumented
Instance Variable	`uistate`	Undocumented
Method	`_do_close`	Undocumented
Method	`_populate_headerbar`	Undocumented
Method	`_update_window_title`	Undocumented
Instance Variable	`_block_toggle_panes`	Undocumented
Instance Variable	`_customtools`	Undocumented
Instance Variable	`_geometry_set`	Undocumented
Instance Variable	`_headerbar`	Undocumented
Instance Variable	`_insertedobjects`	Undocumented
Instance Variable	`_set_fullscreen`	Undocumented
Instance Variable	`_sidepane_autoclose`	Undocumented
Instance Variable	`_switch_focus_accelgroup`	Undocumented
Instance Variable	`_uiactions`	Undocumented

Inherited from WindowBaseMixin:

Method	`do_pane_state_changed`	Undocumented
Method	`do_set_focus`	Undocumented
Method	`set_title`	Undocumented
Method	`setup_toggle_editable_state`	Setup sensitivity of the "toggle_editable" action @param editable_uistate: default state if control is sensitive
Method	`toggle_editable`	Menu action to toggle the read-only state of the application @emits: readonly-changed
Method	`toggle_fullscreen`	Menu action to toggle the fullscreen state of the window
Method	`toggle_panes`	Menu action to toggle the visibility of the all panes @param show: when `True` or `False` force the visibility, when `None` toggle based on current state
Method	`toggle_sidepane_focus`	No summary
Method	`_init_fullscreen_headerbar`	Undocumented
Method	`_on_fullscreen_eventbox_enter`	Undocumented
Method	`_on_fullscreen_eventbox_leave`	Undocumented
Method	`_populate_headerbars`	Undocumented
Method	`_set_tooltip_hack`	Undocumented
Method	`_style_toggle_editable_button`	Undocumented
Method	`_update_fullscreen_revealer`	Undocumented
Instance Variable	`_fullscreen_eventbox`	Undocumented
Instance Variable	`_fullscreen_headerbar`	Undocumented
Instance Variable	`_fullscreen_revealer`	Undocumented
Instance Variable	`_in_fullscreen_eventbox`	Undocumented

Inherited from Window:

Method	`add`	Add the main widget. @param widget: gtk widget to add in the window
Method	`add_bar`	No summary
Method	`add_center_bar`	Add a widget in the central part of the window above the page. @param widget: the gtk widget to show in the tab
Method	`add_tab`	No summary
Method	`do_set_focus`	Undocumented
Method	`focus_last_focussed_sidepane`	Undocumented
Method	`focus_sidepane`	Undocumented
Method	`get_pane_state`	No summary
Method	`get_used_panes`	Returns a list of panes that are in use (i.e. not empty)
Method	`get_visible_panes`	Returns a list of panes that are visible
Method	`move_bottom_minimized_tabs_to_statusbar`	Undocumented
Method	`pack_start`	Undocumented
Method	`present`	Undocumented
Method	`remove`	Remove widget from any pane @param widget: the widget to remove
Method	`set_pane_state`	No summary
Method	`show`	Undocumented
Method	`show_all`	Undocumented
Method	`show_all_panes`	Undocumented
Method	`toggle_panes`	No summary
Method	`_get_pane_ordering`	Undocumented
Method	`_panes`	Undocumented
Method	`_set_pane_ordering`	Undocumented
Instance Variable	`_last_sidepane_focus`	Undocumented
Instance Variable	`_uistate_initialized`	Undocumented
Instance Variable	`_zim_window_bottom_minimized`	Undocumented
Instance Variable	`_zim_window_bottom_pane`	Undocumented
Instance Variable	`_zim_window_bottom_paned`	Undocumented
Instance Variable	`_zim_window_central_hbox`	Undocumented
Instance Variable	`_zim_window_central_vbox`	Undocumented
Instance Variable	`_zim_window_left_minimized`	Undocumented
Instance Variable	`_zim_window_left_pane`	Undocumented
Instance Variable	`_zim_window_left_paned`	Undocumented
Instance Variable	`_zim_window_main`	Undocumented
Instance Variable	`_zim_window_overlay`	Undocumented
Instance Variable	`_zim_window_right_minimized`	Undocumented
Instance Variable	`_zim_window_right_pane`	Undocumented
Instance Variable	`_zim_window_right_paned`	Undocumented
Instance Variable	`_zim_window_sidepanes`	Undocumented
Instance Variable	`_zim_window_top_minimized`	Undocumented
Instance Variable	`_zim_window_top_pane`	Undocumented
Instance Variable	`_zim_window_top_paned`	Undocumented

def __init__(self, notebook, page=None, fullscreen=False, geometry=None): (source)

overrides zim.gui.widgets.Window.__init__

Constructor

Parameters
notebook	the `Notebook` to show in this window
page	a `Path` object to open
fullscreen	if `True` the window is shown fullscreen, if `None` the previous state is restored
geometry	the window geometry as string in format "`WxH+X+Y`", if `None` the previous state is restored

@action(_('_Close'), '<Primary>W')
def close(self): (source)

Menu action for close. Will hide when hideonclose is set, otherwise destroys window, which could result in the application closing if there are no other toplevel windows.

def destroy(self): (source)

Undocumented

def do_button_press_event(self, event): (source)

Undocumented

def do_page_changed(self, page): (source)

Undocumented

def do_page_info_changed(self, notebook, page): (source)

Undocumented

def do_preferences_changed(self, *a): (source)

Undocumented

def init_uistate(self): (source)

overrides zim.gui.widgets.Window.init_uistate

Undocumented

def on_notebook_properties_changed(self, properties): (source)

Undocumented

def on_window_state_event(self, event): (source)

Undocumented

def open_page(self, path, anchor=None, anchor_fail_silent=False): (source)

Method to open a page in the mainwindow, and menu action for the "jump to" menu item.

Fails silently when saving current page failed (which is usually the result of pressing "cancel" in the error dialog shown when saving fails). Check return value for success if you want to be sure.

Parameters
path	a `path` for the page to open.
anchor	name of an anchor (optional)
anchor_fail_silent	Undocumented
Returns
`True` for success
Raises
`PageNotFound`	if `path` can not be opened
Unknown Field: emits
page-changed

@action(_('_Back'), verb_icon='go-previous-symbolic', accelerator='<alt>Left', alt_accelerator='XF86Back', tooltip=_('Go back'))
def open_page_back(self): (source)

Menu action to open the previous page from the history

Returns
`True` if successfull

@action(_('_Child'), '<alt>Down')
def open_page_child(self): (source)

Menu action to open a child page. Either takes the last child from the history, or the first child.

Returns
`True` if successfull

@action(_('_Forward'), verb_icon='go-next-symbolic', accelerator='<alt>Right', alt_accelerator='XF86Forward', tooltip=_('Go forward'))
def open_page_forward(self): (source)

Menu action to open the next page from the history

Returns
`True` if successfull

@action(_('_Home'), '<alt>Home', verb_icon='go-home-symbolic', tooltip=_('Go to home page'))
def open_page_home(self): (source)

Menu action to open the home page

@action(_('_Next in Index'), accelerator='<alt>Page_Down')
def open_page_next(self): (source)

Menu action to open the next page from the index

Returns
`True` if successfull

@action(_('_Parent'), '<alt>Up')
def open_page_parent(self): (source)

Menu action to open the parent page

Returns
`True` if successful

@action(_('_Previous in Index'), accelerator='<alt>Page_Up')
def open_page_previous(self): (source)

Menu action to open the previous page from the index

Returns
`True` if successfull

def save_uistate(self): (source)

overrides zim.gui.widgets.Window.save_uistate

Undocumented

@action(_('_Jump To...'), '<Primary>J')
def show_jump_to(self): (source)

Undocumented

@toggle_action(_('Menubar'), init=True)
def toggle_menubar(self, show): (source)

Menu action to toggle the visibility of the menu bar

Parameters
show	when `True` or `False` force the visibility, when `None` toggle based on current state

def update_buttons_hierarchy(self): (source)

Undocumented

def update_buttons_history(self): (source)

Undocumented

__gsignals__ = (source)

overrides zim.gui.widgets.Window.__gsignals__

Undocumented

hideonclose: bool = (source)

Undocumented

history = (source)

Undocumented

isfullscreen = (source)

Undocumented

maximized = (source)

Undocumented

menubar = (source)

Undocumented

navigation = (source)

Undocumented

notebook = (source)

Undocumented

page = (source)

Undocumented

pageview = (source)

Undocumented

preferences = (source)

Undocumented

uimanager = (source)

Undocumented

uistate = (source)

Undocumented

def _do_close(self): (source)

Undocumented

def _populate_headerbar(self, headerbar): (source)

Undocumented

def _update_window_title(self): (source)

Undocumented

_block_toggle_panes: bool = (source)

overrides zim.gui.mainwindow.WindowBaseMixin._block_toggle_panes

Undocumented

_customtools = (source)

Undocumented

_geometry_set: bool = (source)

Undocumented

_headerbar = (source)

Undocumented

_insertedobjects = (source)

Undocumented

_set_fullscreen: bool = (source)

Undocumented

_sidepane_autoclose: bool = (source)

overrides zim.gui.mainwindow.WindowBaseMixin._sidepane_autoclose

Undocumented

_switch_focus_accelgroup = (source)

Undocumented

_uiactions = (source)

Undocumented