Part of elisa.plugins.poblesec.configuration_wizard View In Hierarchy
Configuration wizard controller. A configuration wizard is built from a list of option screens. It handles the navigation between those screens, associating each action of a given screen to another screen. Screens are identified by a name. Two special names are reserved: 'quit' and 'done'. - 'quit' quits the application - 'done' closes the configuration wizard The following is a simple example of how to instantiate a configuration wizard with two screens: welcome = (WelcomeScreen, {'next': 'final', 'quit': 'quit'}) final = (FinalScreen, {'next': 'done', 'prev': 'welcome'}) screens = {'welcome': welcome, 'final': final} wizard_dfr = ConfigurationWizard.create(None, screens=screens, start='welcome')
Line # | Kind | Name | Docs |
---|---|---|---|
64 | Method | initialize | |
108 | Method | clean | Clean the component. |
211 | Method | start | Create and show the first option screen. |
223 | Method | handle_input | Undocumented |
114 | Method | _mouse_event_cb | Undocumented |
118 | Method | _focus_cb | Undocumented |
122 | Method | _connect_closed_signal | Undocumented |
126 | Method | _closed_cb | Undocumented |
151 | Method | _create_screen | Undocumented |
165 | Method | _place_screen | Undocumented |
169 | Method | _show_screen | Undocumented |
186 | Method | _hide_screen | Undocumented |
197 | Method | _change_screen | Undocumented |
Inherited from PigmentController:
Line # | Kind | Name | Docs |
---|---|---|---|
50 | Method | __init__ | Undocumented |
59 | Method | set_frontend | Set the frontend for the controller. |
68 | Method | set_path | Set the path for the controller. |
83 | Method | has_focus | Undocumented |
86 | Method | prepare | Called after widget is
added to the canvas. It is sensible to do |
93 | Method | removed | Called after widget is
removed from the canvas. |
Inherited from Component (via PigmentController, Controller):
Line # | Kind | Name | Docs |
---|---|---|---|
85 | Class | PathDescriptor | Undocumented |
97 | Class Method | create | Create and initialize the component. |
Parameters | screens | a dictionary associating screen names to the corresponding classes and the
action associations
(type: dict of str : (class ,
dict of str : str )
) |
start | the name of the first screen of the wizard
(type: str
) | |
Raises | ValueError | when screens is empty |
This method is called when a component is not needed anymore to clean its state.
Returns | a deferred called when the component has finished cleaning its state
(type: twisted.internet.defer.Deferred
) |
Returns | a deferred fired when the screen is shown
(type: elisa.core.utils.defer.Deferred
) |