Adams Basic Package > Adams View > View Command Language > interface > interface radio_box modify

interface radio_box modify

Allows modifying an existing radio box

Format:

 
interface radio box modify
radio_box_name =
An Existing GI_radio_box
new_radio_box_name =
A New GI_radio Box
enabled =
Boolean
help_text =
String
documentation_text =
String
units =
Int_units
horiz_resizing =
Int_h_resize
vert_resizing =
Int_v_resize
location =
Real
height =
Real
width =
Real
choices =
String
values =
String
commands =
String
current_choice =
String

Example:

 
interface radio_box modify &
radio_box_name =
.gui.obj.rdbx &
enabled =
yes &
help_text =
"help_text" &
documentation_text =
"doc_text" &
units =
relative &
horiz_resizing =
attach_left &
vert_resizing =
attach_top &
location =
0.0,0.0 &
height =
0.4 &
width =
0.4 &
choices =
yes &
values =
“1” &
commands =
"interface coord_window display=toggle" &
current_choice =
"yes"

Description:

 
Parameter
Value Type
Description
radio_box_name
An Existing GI_radio Box
Specifies the name of an existing radio box
new_radio_box_name
A New GI_radio_box
Specifies a new name for an existing radio box
enabled
Boolean
Activates the radio box
help_text
String
Specifies the help text
documentation_text
String
Specifies the documentation text
units
Int_units
Specifies the radio box size as pixel or relative to Adams window
horiz_resizing
Int_h_resize
Specifies the attachment and scaling option for radio box
vert_resizing
Int_v_resize
Specifies the attachment and scaling option for radio box
location
Real
Specifies the location of the radio box
height
Real
Specifies the height of the radio box in terms of relative units or pixel
width
Real
Specifies the width of the radio box in terms of relative units or pixel
choices
String
Specifies labels of the choices to be displayed for the radio box
values
String
Specifies the real values to be stored in result component
commands
String
Specifies the command to be executed by the radio box
current choice
String
Specifies the default choice to be executed by the radio box

Extended Definition:

1. The name of the radio box to be created is specified initially. If parameter ‘Enabled’ is set to ON, the radio box button will be preactivated. A new name can be suggested for the radio box by specifying the parameter ‘new_radio_box_name’.
2. The pop-up help and documentation help can be specified in appropriate dialog boxes.
3. The size of the radio box can be specified either in terms of number of pixels. Alternatively, the size can also be stated as relative to the Adams window
4. The vertical and horizontal resizing options are used to adjust the placement of the radio box on existing dialog box. For example, attach_left; attach_top options for Horiz_resizing and Vert_resizing will place the radio box on the top left corner of the dialog box. The location can also be specified from the top left corner by adjusting the parameter ‘location’
5. The size of the radio box window can be specified with respect to the Adams window size. The value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0 represents the height of the Adams View window. Therefore, a value of 1.0 will set the button window to be one half as high as the Adams View window.
6. The parameter ‘command’ specifies the name of the command to be executed when the radio box is clicked. If multiple commands are entered then the command to be executed is decided by the parameter ‘choice’. Alternatively, the values specifies the real values to be stored in the result set component, The values can be a list of numbers, or an expression referencing an array of existing values. The ‘current choice’ parameter decides the default value for the radio box from the choices offered.