zim.gui.widgets.AssistantPage

class documentation

class AssistantPage(Gtk.VBox): (source)

Known subclasses: zim.gui.exportdialog.FormatPage, zim.gui.exportdialog.InputPage, zim.gui.exportdialog.OutputPage

View In Hierarchy

Base class for pages in an Assistant dialog.

Typically each page will contain a number of input widgets that are logically grouped. After filling them in the user presses "Forward" to go to the next page. In order for the "Forward" button to becomes sensitive all widgets must have valid input.

Unknown Field: signal
`input-valid-changed ()`: emitted when the valid state of the page changed

Method	`__init__`	Constructor @param assistant: the `Assistant` dialog
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	`check_input_valid`	Check overall valid stat of the page. Called if the valid state if the form is changed. And should be called for any other custom widgets in the page.
Method	`get_input_valid`	Get valid state for the page @returns: `True` if all input is valid
Method	`init_uistate`	No summary
Method	`save_uistate`	This method is called before leaving the page. It should be used to update uitstate based on in put widgets.
Class Variable	`__gsignals__`	Undocumented
Class Variable	`title`	title to show above this page
Instance Variable	`assistant`	the dialog this page belongs to
Instance Variable	`form`	an `InputForm` when `add_form()` was used
Instance Variable	`uistate`	dict shared between all pages in the same dialog, use this to set values giving the interface state.
Instance Variable	`_input_valid`	Undocumented

def __init__(self, assistant): (source)

overridden in zim.gui.exportdialog.FormatPage, zim.gui.exportdialog.InputPage, zim.gui.exportdialog.OutputPage

Constructor

Parameters
assistant	the `Assistant` dialog

def add_form(self, inputs, values=None, depends=None): (source)

Convenience method to construct a form with input widgets and add them to the dialog. See InputForm.add_inputs() for details.

Parameters
inputs	list with input definitions
values	initial values for the inputs
depends	dict with dependencies between inputs

def check_input_valid(self): (source)

Check overall valid stat of the page. Called if the valid state if the form is changed. And should be called for any other custom widgets in the page.

Unknown Field: implementation
should be implemented by sub-classes that add widgets outside of the form
Unknown Field: emits
input-valid

def get_input_valid(self): (source)

Get valid state for the page

Returns
`True` if all input is valid

def init_uistate(self): (source)

overridden in zim.gui.exportdialog.FormatPage, zim.gui.exportdialog.InputPage, zim.gui.exportdialog.OutputPage

This method is called when this page is shown in the dialog. Should be used to update uistate according to input of other pages. Keep in mind that uistate can have changed since the constructor was called - even when this is the first page, the dialog has a "Back" button.

Unknown Field: implementation
must be implementated by all subclasseses

def save_uistate(self): (source)

overridden in zim.gui.exportdialog.FormatPage, zim.gui.exportdialog.InputPage, zim.gui.exportdialog.OutputPage

This method is called before leaving the page. It should be used to update uitstate based on in put widgets.

Unknown Field: implementation
must be implementated by all subclasseses that do not update uistate in real time

__gsignals__ = (source)

Undocumented

title: str = (source)

overridden in zim.gui.exportdialog.FormatPage, zim.gui.exportdialog.InputPage, zim.gui.exportdialog.OutputPage

title to show above this page

assistant = (source)

the dialog this page belongs to

form = (source)

an InputForm when add_form() was used

uistate = (source)

dict shared between all pages in the same dialog, use this to set values giving the interface state.

_input_valid = (source)

Undocumented