zim.gui.notebookdialog.NotebookDialog

class documentation

class NotebookDialog(Dialog): (source)

Dialog which allows the user to select a notebook from a list of defined notebooks.

Can either be run modal using run(), in which case the selected notebook is returned (or None when the dialog is canceled). To run this dialog non-model a callback needs to be specified which will be called with the path for the selected notebook.

Method	`__init__`	Constructor.
Method	`do_add_notebook`	Undocumented
Method	`do_remove_notebook`	Undocumented
Method	`do_response_ok`	Handler called when the user clicks the "OK" button (or an equivalent button)
Method	`show_all`	Undocumented
Method	`show_help`	Show a help page @param page: the manual page, if `None` the page as set with `set_help()` is used
Instance Variable	`callback`	Undocumented
Instance Variable	`combobox`	Undocumented
Instance Variable	`result`	Undocumented
Instance Variable	`treeview`	Undocumented

Inherited from Dialog:

Class Method	`unique`	No summary
Method	`add_extra_button`	No summary
Method	`add_form`	Convenience method to construct a form with input widgets and add them to the dialog. See `InputForm.add_inputs()` for details.
Method	`add_help_text`	Adds a label with an info icon in front of it. Intended for informational text in dialogs. @param text: help text
Method	`add_text`	Adds a label to the dialog Also see `add_help_text()` for another style option. @param text: dialog text
Method	`assert_response_ok`	No summary
Method	`do_response`	Undocumented
Method	`do_response_cancel`	Handler called when the user clicks the "Cancel" button.
Method	`get_input`	Method used in test suite to get "interactive" inputs
Method	`get_input_enabled`	Undocumented
Method	`on_destroy`	Undocumented
Method	`present`	Undocumented
Method	`response_ok`	Trigger the response signal with response type 'OK'.
Method	`run`	Wrapper for `Gtk.Dialog.run()`, also calls `show_all()` @returns: `self.result`
Method	`save_uistate`	Method when the dialog is about to exit or hide and wants to save the uistate. Sub-classes implementing this method should use it to set additional state parameter in `self.uistate`.
Method	`set_help`	Set the name of the manual page with help for this dialog. Setting this will add a "help" button to the dialog. @param pagename: the manual page name
Method	`set_input`	No summary
Method	`show`	Undocumented
Instance Variable	`destroyed`	when `True` the dialog is already destroyed
Instance Variable	`form`	`InputForm` added by `add_form()`
Instance Variable	`help_page`	Undocumented
Instance Variable	`uistate`	`ConfigDict` to store state of the dialog, persistent per notebook. The size and position of the dialog are stored as automatically in this dict already.
Instance Variable	`vbox`	`Gtk.VBox` for main widgets of the dialog
Instance Variable	`_no_ok_action`	Undocumented

Inherited from ConnectorMixin (via Dialog):

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, parent, callback=None): (source)

overrides zim.gui.widgets.Dialog.__init__

Constructor.

Parameters
parent	either a parent gtk widget or `None`. Only used to set the dialog on top of the right parent window
callback	Undocumented
title	the dialog title
buttons	a constant controlling what kind of buttons the dialog will have. One of: `None` or `Gtk.ButtonsType.NONE`: for dialogs taking care of constructing the buttons themselves `Gtk.ButtonsType.OK_CANCEL`: Render Ok and Cancel `Gtk.ButtonsType.CLOSE`: Only set a Close button
button	a label to use instead of the default 'Ok' button
help_text	set the help text, see `add_help_text()`
help	pagename for a manual page, see `set_help()`
defaultwindowsize	default window size in pixels

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

Undocumented

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

Undocumented

def do_response_ok(self): (source)

overrides zim.gui.widgets.Dialog.do_response_ok

Handler called when the user clicks the "OK" button (or an equivalent button)

Returns
`True` if successfull and the dialog can close. Returns `False` if e.g. input is not valid, this will keep the dialog open.
Unknown Field: implementation
must be implemented by sub-classes that have an "OK" button

def show_all(self): (source)

overrides zim.gui.widgets.Dialog.show_all

Undocumented

def show_help(self, page=None): (source)

overrides zim.gui.widgets.Dialog.show_help

Show a help page

Parameters
page	the manual page, if `None` the page as set with `set_help()` is used

callback = (source)

Undocumented

combobox = (source)

Undocumented

result = (source)

overrides zim.gui.widgets.Dialog.result

Undocumented

treeview = (source)

Undocumented