Common widget manipulation, service start widget |
modules/CWMServiceStart.ycp |
Routines for service start widget handling | |
|
|
This module has an unstable interface. |
Label saying that service is running
Label saying that service is stopped
Last status of the service
Update the displayed status of the service
- Parameters:
-
widget a map describing the widget
Update the widget displaying if LDAP support is active
- Parameters:
-
widget a map describing the widget
Handle the "Use LDAP" check box
- Parameters:
-
widget a map describing the widget param event_id any the ID of the occurred event event_id
Init function of the widget
- Parameters:
-
widget key strnig the widget key
Store function of the widget
- Parameters:
-
widget key strnig the widget key event map that caused widget data storing
Init function of the widget
- Parameters:
-
key strnig the widget key
Store function of the widget
- Parameters:
-
key strnig the widget key event map that caused widget data storing
Get the template for the help text to the auto start widget
- Return value:
-
help text template with %1 and %2 placeholders
Get the template for the help text to the auto start widget
- Return value:
-
help text template with %1 and %2 placeholders
Get the help text to the auto start widget
- Return value:
-
help text
Get the help text to the auto start widget
- Return value:
-
help text
Get the widget description map of the widget for service auto starting settings
- Parameters:
-
settings a map of all parameters needed to create the widget properly - "get_service_auto_start" : boolean () -- function that returns if the service is set for automatical start-up - "set_service_auto_start" : void (boolean) -- function that takes as an argument boolean value saying if the service is started automatically during booting - "get_service_start_via_xinetd" : boolean () -- function that returns if the service is to be started via xinetd. At most one of this function and "get_service_auto_start" returns true (if started via xinetd, not starting automatically - "set_service_start_via_xinetd" : void (boolean) - function that takes as an argument boolean value saying if the service is started via xinetd - "start_auto_button" : string -- label of the radio button to start the service automatically when booting - "start_xinetd_button" : string -- label of the radio button to start the service via xinetd - "start_manual_button" : string -- label of the radio button to start the service only manually - "help" : string -- custom help for the widget. If not specified, generic help is used
Additional settings: - "help" : string -- help to the whole widget. If not specified, generic help is used (button labels are patched correctly)
- Return value:
-
the widget description map
Handle the immediate start and stop of the service
- Parameters:
-
widget a map describing the widget key strnig the widget key event
- Return value:
-
always nil
Init function of the widget
- Parameters:
-
widget key strnig the widget key
Handle the immediate start and stop of the service
- Parameters:
-
key strnig the widget key event
- Return value:
-
always nil
Init function of the widget
- Parameters:
-
key strnig the widget key
Get the template for the help text to the start/stop widget
- Parameters:
-
restart_displayed shold be true if "Save and restart" is displayed
- Return value:
-
help text template with %1 and %2 placeholders
Get the help text to the start/stop widget
- Parameters:
-
restart_displayed shold be true if "Save and restart" is displayed
- Return value:
-
help text
Get the widget description map for immediate service start/stop and appropriate actions
- Parameters:
-
settings a map of all parameters needed to create the widget properly - "service_id" : string -- service identifier for Service:: functions. If not specified, immediate actions buttons are not displayed. - "save_now_action" : void () -- function that causes saving of all settings and restarting the service. If key is missing, the button is not displayed - "start_now_action" : void () -- function that causes starting the service If not specified, generic function using "service_id" is used instead - "stop_now_action" : void () -- function that causes stopping the service If not specified, generic function using "service_id" is used instead - "service_running_label" : string -- label to be displayed if the service is running. - "service_not_running_label" : string -- label to be displayed if the service is stopped. - "start_now_button" : string -- label for the push button for immediate service start - "stop_now_button" : string -- label for the push button for immediate service stop - "save_now_button" : string -- label for the push button for immediate settings saving and service restarting - "help" : string -- help to the widget. If not specified, generic help is used (button labels are patched correctly)
- Return value:
-
the widget description map
Init function of the widget
- Parameters:
-
widget key strnig the widget key
Handle function of the widget
- Parameters:
-
widget key strnig the widget key event map event to be handled
- Return value:
-
for wizard sequencer or nil
Init function of the widget
- Parameters:
-
key strnig the widget key
Handle function of the widget
- Parameters:
-
key strnig the widget key event map event to be handled
- Return value:
-
for wizard sequencer or nil
Get the template for the help text to the LDAP enablement widget
- Return value:
-
help text template with %1 and %2 placeholders
Get the help text to the LDAP enablement widget
- Return value:
-
help text
Get the widget description map of the LDAP enablement widget TODO: Find a file to move to
- Parameters:
-
settings a map of all parameters needed to create the widget properly LDAP support: - "get_use_ldap" : boolean () -- function to return current status of the LDAP support. If not set, LDAP check-box is not shown. - "set_use_ldap" : void (boolean) -- function to set the LDAP usage and report errors in case of fails. Status will be rechecked via "get_use_ldap". If not set, LDAP check-box is not shown. - "use_ldap_checkbox" : string -- label of the chcek box to set if LDAP support is active. - "help" : string -- help to the widget. If not specified, generic help is used (button labels are patched correctly)
- Return value:
-
the widget description map