zim.plugins.quicknote.QuickNoteDialog

class documentation

class QuickNoteDialog(Dialog): (source)

Dialog bound to a specific notebook

Method	`__init__`	Constructor.
Method	`append_to_page`	Undocumented
Method	`create_new_page`	Undocumented
Method	`do_delete_event`	Undocumented
Method	`do_response`	Undocumented
Method	`do_response_ok`	Handler called when the user clicks the "OK" button (or an equivalent button)
Method	`import_attachments`	Undocumented
Method	`on_notebook_changed`	Undocumented
Method	`on_text_changed`	Undocumented
Method	`on_title_changed`	Undocumented
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	`show`	Undocumented
Instance Variable	`attachments`	Undocumented
Instance Variable	`config`	Undocumented
Instance Variable	`form`	Undocumented
Instance Variable	`notebookcombobox`	Undocumented
Instance Variable	`open_page_check`	Undocumented
Instance Variable	`textview`	Undocumented
Instance Variable	`uistate`	Undocumented
Method	`_get_notebook`	Undocumented
Method	`_init_inputs`	Undocumented
Method	`_set_autocomplete`	Undocumented
Instance Variable	`_title_set_manually`	Undocumented
Instance Variable	`_updating_title`	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_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	`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_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	`destroyed`	when `True` the dialog is already destroyed
Instance Variable	`help_page`	Undocumented
Instance Variable	`result`	result to be returned by `run()`
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, window, notebook=None, page=None, namespace=None, basename=None, append=None, text=None, template_options=None, attachments=None): (source)

overrides zim.gui.widgets.Dialog.__init__

Constructor.

Parameters
window	Undocumented
notebook	Undocumented
page	Undocumented
namespace	Undocumented
basename	Undocumented
append	Undocumented
text	Undocumented
template_options	Undocumented
attachments	Undocumented
parent	either a parent gtk widget or `None`. Only used to set the dialog on top of the right parent window
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 append_to_page(self, notebook, path, text): (source)

Undocumented

def create_new_page(self, notebook, path, text): (source)

Undocumented

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

Undocumented

def do_response(self, id): (source)

overrides zim.gui.widgets.Dialog.do_response

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 import_attachments(self, notebook, path, dir): (source)

Undocumented

def on_notebook_changed(self, o): (source)

Undocumented

def on_text_changed(self, buffer): (source)

Undocumented

def on_title_changed(self, o): (source)

Undocumented

def run(self): (source)

overrides zim.gui.widgets.Dialog.run

Wrapper for Gtk.Dialog.run(), also calls show_all()

Returns
`self.result`

def save_uistate(self): (source)

overrides zim.gui.widgets.Dialog.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.

Unknown Field: implementation
can be implemented by sub-classes that have some additional uistate to save

def show(self): (source)

overrides zim.gui.widgets.Dialog.show

Undocumented

attachments = (source)

Undocumented

config = (source)

Undocumented

form = (source)

overrides zim.gui.widgets.Dialog.form

Undocumented

notebookcombobox = (source)

Undocumented

open_page_check = (source)

Undocumented

textview = (source)

Undocumented

uistate = (source)

overrides zim.gui.widgets.Dialog.uistate

Undocumented

def _get_notebook(self): (source)

Undocumented

def _init_inputs(self, namespace, basename, append, text, template_options, custom=None): (source)

Undocumented

def _set_autocomplete(self, notebook): (source)

Undocumented

_title_set_manually: bool = (source)

Undocumented

_updating_title: bool = (source)

Undocumented