Class e.p.p.c.o.OptionScreen(PigmentController):

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 the setup 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 Variablesstandalonewhether the screen is standalone or part of a wizard (type: bool )
Class Variablesactionsa 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.
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.
99 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.
def __init__(self):
Undocumented
def setup(self):
Set up the screen (i.e. retrieve the current state of the configuration and populate its data).
Returnsa deferred fired when the set up is complete (type: elisa.core.utils.defer.Deferred )
def close(self, action, save=False):
Close the configuration screen, and optionally save back the new state of the configuration.
Parametersactionthe action chosen by the user (type: str )
savewhether to save the new state of the configuration (type: bool )
RaisesValueErrorwhen action is unknown
def save(self):
Save back the new state of the configuration. This method should be implemented by every specific option screen.
def handle_input_ok(self):
Default handling of the OK event.

Save the new configuration and close the screen.

def handle_input_cancel(self):
Default handling of the Return event.

Close the screen without altering the current configuration.

def go_back(self):
In standalone mode, go up one level in the history of controllers.
Unknown Field: attentionshould not be called when not in standalone mode.
def handle_input(self, manager, input_event):
Undocumented
API Documentation for Elisa Media Center, generated by pydoctor at 2009-02-16 19:15:05.