MenuTarea()

Display a text area menu in the panel window.

Usage

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

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 (string)
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 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.
menuText (string)
The text which is shown above the Text Editor to tell you the syntax of data you can enter.

Return Value

None

Errors

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

Description

This routine places a text area menu in the panel window. The menu contains a label given by the name argument and a push button. When you click this button, a window opens allowing you to write a set of text in it. The displayed value is extracted from the data base node and par. Upon change, the value is deposited back onto the data base. Now, if redraw is True, the entire panel is redrawn. This provides the opportunity to change the other menu selections. For example,
nodeAna = ROOT + RS + 'ANALYSIS'
MenuTarea( name = "Pressure script",
           tooltip = "Coordinates based script for pressure",
           whatsthis= "Specify a python script to initialize pressure "
                      "values at each node based on its xyz values "
                      "example: value = sin( 2 * x )",
helpURL = URL + '#pressure_script',
node = nodeNic+RS+'pressure',
par = "script",
default = "",
menuText= "Enter a python script in terms of x, "
          "y and z\nFor example:\n len = 2.5\n "
          "theta = 2 * pi * x / len\n value = "
          "sin( theta )\nSet the nodal initial "
          "condition in \"value\"" )