Part of elisa.plugins.poblesec.configuration.option_screen View In Hierarchy
Known subclasses: elisa.plugins.poblesec.configuration.base.BaseScreen
Base controller for an option screen used for configuration.
It may be used either as a step of a configuration wizard, or as a standalone option screen controller.
An option screen may use a backend to populate its data, retrieve the current state of the configuration and save the new state back to the configuration. Initial population should be implemented in thesetup
method (and this method should be explicitely called after the
initialization of the screen is done, this is not done automatically).
Saving back the new state of the configuration should be implemented in the
save
method.
Instance Variables | standalone | whether the screen is standalone or part of a wizard
(type: bool
) |
Class Variables | actions | a list of possible actions
(type: list of str
) |
Line # | Kind | Name | Docs |
---|---|---|---|
64 | Method | __init__ | Undocumented |
68 | Method | setup | Set up the screen (i.e. retrieve the current state of the configuration |
78 | Method | close | Close the configuration screen, and optionally save back the new state |
98 | Method | save | Save back the new state of the configuration. |
105 | Method | handle_input_ok | Default handling of the OK event.
|
113 | Method | handle_input_cancel | Default handling of the Return event.
|
121 | Method | go_back | In standalone mode, go up one level in the history of controllers. |
130 | Method | handle_input | Undocumented |
Inherited from PigmentController:
Line # | Kind | Name | Docs |
---|---|---|---|
59 | Method | set_frontend | Set the frontend for the controller. |
68 | Method | set_path | Set the path for the controller. |
80 | Method | has_focus | Undocumented |
83 | Method | prepare | Called after widget is
added to the canvas. It is sensible to do
|
90 | Method | removed | Called after widget is
removed from the canvas.
|
96 | Method | clean | Clean the component. |
Inherited from Component (via PigmentController, Controller):
Line # | Kind | Name | Docs |
---|---|---|---|
85 | Class | PathDescriptor | Undocumented |
97 | Class Method | create | Create and initialize the component. |
130 | Method | initialize | Initialize the component. |
Returns | a deferred fired when the set up is complete
(type: elisa.core.utils.defer.Deferred
) |
Parameters | action | the action chosen by the user
(type: str
) |
save | whether to save the new state of the configuration
(type: bool
) | |
Raises | ValueError | when action is unknown |
Default handling of the OK
event.
Default handling of the Return
event.
Unknown Field: attention | should not be called when not in standalone mode. |