MenuBool()

Usage

MenuBool( name, node, par,
                    default=None, tooltip=None, whatsthis=None,
                    helpURL=None, redraw=False )

Parameters

name (string)

Label of the menu. This is displayed on the left.

node (string)

Data base path of the node containing the parameter.

par (string)

Parameter name. The value of the menu is extracted from this parameter under the above node, and upon change by you, the value is deposited therein.

default (boolean)

Default value. If the data base does not contain the parameter given by the node and par arguments, it is first initialized to this value.

tooltip (string)

Tooltip help information, also known as bubble. The content of this argument is displayed in a small dynamic box placed opened above the menu, when the cursor remains at the menu for short time. This is typically a short phrase.

whatsthis (string)

Whatsthis help information. When you click on the whatsthis icon followed by clicking on this menu, a small box opens above the menu and the content of this argument is displayed in it. This is typically a short sentence or two, which provides more information than that given by the tooltip argument. The whatsthis argument is a rich text format, which means you can embed many of the HTML tags, such as <br> for line separator and <b> for bold.

helpURL (string)

This is the HTML-URL address containing detailed help on the menu item. When you press the F1 key while the cursor is on top of this menu, the assistance help system opens and displays this page.

redraw (boolean)

Flag specifying whether to redraw the panel when you change the value. This allows inclusion of complex menus that dynamically depend on the value of this menu.

Return Value

None

Errors

• The parameter in the data base must be of type boolean.
• The parameter must exist in the data base or the default must not be None.

Description

nodeAss = ROOT + RS + 'AUTO_SOLUTION_STRATEGY'
MenuBool(name = 'Auto time incerment',
         tooltip = 'Use automatic time increment?',
         whatsthis= 'Use an automatic time increment strategy?\n'
                  'if yes, the time increment is adjusted\n'
                  'automatically based on convergence and\n'
                  'other criteria within a time step',
         helpURL = URL + '#auto_time_increment',
         node = nodeAss,
         par = 'auto_time_increment',
         redraw = True,
         default = False )