Routines for common widget manipulation
List of Global Functions
AdjustButtons - Adjust the labels of the bottom buttons of the wizard sequencer
CreateWidgets - Read widgets with listed names
DisableButtons - Disable given bottom buttons of the wizard sequencer
GetProcessedWidget - Return description map of currently processed widget
InitNull - Do-nothing replacement for a widget initialization function. Used for push buttons if all the other widgets have a fallback.
MergeHelps - Merge helps from the widgets
OkCancelBox - Create a term with OK and Cancel buttons placed horizontally
PrepareDialog - Prepare the dialog, replace strings in the term with appropriate widgets
ReplaceWidgetHelp - Replace help for a particular widget
Run - Generic function to create dialog and handle it's events
SetValidationFailedHandler - Set handler to be called after validation of a dialog failed
ShowAndRun - Display the dialog and run its event loop
ShowAndRunOrig - Display the dialog and run its event loop
StoreNull - Do-nothing replacement for a widget storing function. Used for push buttons if all the other widgets have a fallback.
StringsOfTerm - Process term with the dialog, return all strings. To be used as an argument for widget_names until they are obsoleted.
ValidateBasicType - Validate the value against the basic type
ValidateMaps - Validate widget description map, check for maps structure Also checks option description maps if present
ValidateValueType - Validate type of entry of the widget/option description map Also checks option description maps if present
cleanupWidgets - Cleanup after dialog was finished (independently on what event) global only because of testsuites
handleWidgets - Handle change of widget after event generated global only because of testsuites
initWidgets - Set widgets according to internally stored settings global only because of testsuites
mergeFunctions - Add fallback functions to a widget global only because of testsuites
prepareWidget - Prepare a widget for usage
saveWidgets - Save changes of widget after event generated global only because of testsuites CWMTab uses it too
validateWidget - Validate single widget
validateWidgets - Validate dialog contents for allow it to be saved
List of Global Variables
Adjust the labels of the bottom buttons of the wizard sequencer
Function parameters
string next
string back
string abort
string help
Return value
void
Read widgets with listed names
Function parameters
list<string> names
map<string,map<string,any> > source
Return value
list<map<string, any> > - of maps representing widgets
Disable given bottom buttons of the wizard sequencer
Function parameters
list<string> buttons
Return value
void
Return description map of currently processed widget
Return value
map<string, any> - description map of currently processed widget
Do-nothing replacement for a widget initialization function. Used for push buttons if all the other widgets have a fallback.
Function parameters
string key
Return value
void
Merge helps from the widgets
Function parameters
list<map<string,any> > widgets
Return value
string - merged helps of the widgets
Create a term with OK and Cancel buttons placed horizontally
Return value
term - the term (HBox)
Prepare the dialog, replace strings in the term with appropriate widgets
Function parameters
term dialog
list<map<string,any> > widgets
Return value
term - updated term ready to be used as a dialog
Replace help for a particular widget
Function parameters
string widget
string help
Return value
void
Generic function to create dialog and handle it's events
Function parameters
list<map<string, any> > widgets
map<any, any> functions
Return value
symbol - wizard sequencer symbol
Set handler to be called after validation of a dialog failed
Return value
void
Display the dialog and run its event loop
Function parameters
map<string,any> settings
Return value
symbol
Display the dialog and run its event loop
Function parameters
list<string> widget_names
map<string,map<string,any> > widget_descr
term contents
string caption
string back_button
string next_button
map<any, any> fallback
Return value
symbol - wizard sequencer symbol
Do-nothing replacement for a widget storing function. Used for push buttons if all the other widgets have a fallback.
Function parameters
string key
map event
Return value
void
Process term with the dialog, return all strings. To be used as an argument for widget_names until they are obsoleted.
Function parameters
term t
Return value
list<string> - strings found in the term
Validate the value against the basic type
Function parameters
any value
string type
Return value
boolean - true on success or if do not know how to validate
Validate widget description map, check for maps structure Also checks option description maps if present
Function parameters
map<string,map<string,any> > widgets
Return value
boolean - true on success
Validate type of entry of the widget/option description map Also checks option description maps if present
Function parameters
string key
any value
string widget
Return value
boolean - true if validation succeeded
Cleanup after dialog was finished (independently on what event) global only because of testsuites
Function parameters
list<map<string,any> > widgets
Return value
void
Handle change of widget after event generated global only because of testsuites
Function parameters
list<map <string, any> > widgets
map event_descr
Return value
symbol - modified action (sometimes may be needed) or nil
Set widgets according to internally stored settings global only because of testsuites
Function parameters
list<map<string, any> > widgets
Return value
void
Add fallback functions to a widget global only because of testsuites
Function parameters
list<map <string, any> > widgets
map<any, any> functions
Return value
list<map <string, any> > - a list of modified widget description maps
Prepare a widget for usage
Function parameters
map<string, any> widget_descr
Return value
map<string, any> - modified widget description map
Save changes of widget after event generated global only because of testsuites CWMTab uses it too
Function parameters
list<map<string,any> > widgets
map event
Return value
void
Validate single widget
Function parameters
map<string, any> widget
map event
string key
Return value
boolean - true if validation succeeded