177. OSRPopup

177.1. Summary of Module Globals

List of Global Functions

  • ChangeFieldDialog - Dialog to change one field in the fstab.

  • MultiSelectionBox - A dialog with to messages and a multi selection box in the center.

  • OpenMainRepairDialog - Open a dialog with the term r_options in the center.

  • OpenSuggestDialog - Open the base dialog to suggest modify.

  • RadioButtonGroup - This method opens a popup window that offers the specified items to the user. The items can be selected in a RadioButtonGroup. A default item has to be specified. It is marked as selected from start. If the default is "", the first item in the list is marked as selected. It provides an OK button and a Cancel button. If OK is pressed the selected item is returned as a string, if cancel is pressed, the specified default is returned.

  • RadioButtonGroupText - This method opens a popup window that offers the specified items to the user. The items can be selected in a RadioButtonGroup. A default item has to be specified. It is marked as selected from start. If the default is "", the first item in the list is marked as selected. It provides an OK button and a Cancel button. If OK is pressed the selected item is returned as a string, if cancel is pressed, the specified cancel-value is returned.

  • Repair - This method opens a new popup window that displays the error message. It provides a repair button, a skip button and a help button.

  • build_label_description - Build (return) a description text for a label in the help_text field.

List of Global Variables

    177.2. Global Functions

    177.2.1. ChangeFieldDialog

    Dialog to change one field in the fstab.

    Function parameters

    • string org_value

    • string description

    Return value

    • string

    177.2.2. MultiSelectionBox

    A dialog with to messages and a multi selection box in the center.

    Function parameters

    • string headline

    • string message_top

    • string message_bottom

    • string help_text

    • string box_headline

    • list<list> item_list

    • list<list> special_buttons_list

    Return value

    • list<string>

    177.2.3. OpenMainRepairDialog

    Open a dialog with the term r_options in the center.

    Function parameters

    • string headline

    • string error_text

    • term r_options

    Return value

    • boolean

    177.2.4. OpenSuggestDialog

    Open the base dialog to suggest modify.

    Function parameters

    • string headline

    • string message

    • string help_text

    • term body

    • integer hweight

    Return value

    • boolean

    177.2.5. RadioButtonGroup

    This method opens a popup window that offers the specified items to the user. The items can be selected in a RadioButtonGroup. A default item has to be specified. It is marked as selected from start. If the default is "", the first item in the list is marked as selected. It provides an OK button and a Cancel button. If OK is pressed the selected item is returned as a string, if cancel is pressed, the specified default is returned.

    Function parameters

    • string headline

    • string message

    • list<string> item_list

    • string default_val

    • boolean strict

    Return value

    • string - The selected item, the default if cancel is pressed.

    Example 44. 

     string result = OSRPopup::RadioButtonGroup("Test", "This is just a test.", ["a", "b", "c"], "b", true);


    177.2.6. RadioButtonGroupText

    This method opens a popup window that offers the specified items to the user. The items can be selected in a RadioButtonGroup. A default item has to be specified. It is marked as selected from start. If the default is "", the first item in the list is marked as selected. It provides an OK button and a Cancel button. If OK is pressed the selected item is returned as a string, if cancel is pressed, the specified cancel-value is returned.

    Function parameters

    • string headline

    • string message

    • list<list> item_list

    • string default_val

    • string cancel

    • boolean strict

    Return value

    • string - The selected item, the default if cancel is pressed.

    Example 45. 

     string result = OSRPopup::RadioButtonGroupText("Test",
                                                      "This is a test.",
    						      [["a" , "First choice"], ["b", "Second choice"]],
    						      "b",
    						      "cancel",
    						      true); 


    177.2.7. Repair

    This method opens a new popup window that displays the error message. It provides a repair button, a skip button and a help button.

    Function parameters

    • string headline

    • string message

    • string help_text

    Return value

    • boolean - True if the repair button was pressed by the user.

    Example 46. 

     boolean repair_question = OSRPopup::Repair( "Error detected", error_message, help_text);


    177.2.8. build_label_description

    Build (return) a description text for a label in the help_text field.

    Function parameters

    • string label

    • string description

    Return value

    • string - the formatted label help text

    177.3. Global Variables

    177.4. Module Requirements

    177.4.1. Module Imports

    • Label
    • OSRCommon
    • OSRMode
    • Popup

    177.4.2. Module Includes