interface push_button modify
Allows you to modify an existing push button.
Format:
interface push_button modify |
|---|
push_button_name = | an existing GI_push_btn |
new_push_button_name = | a new GI_push_btn |
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 |
label = | string |
icon_file= | string |
commands = | string |
dbl_commands = | string |
default = | true_false |
Example:
interface push_button create & |
push_button_name = | operate & |
new_push_button_name = | operate_new& |
enabled = | yes & |
help_text = | text_help & |
documentation_text = | doc_help & |
units = | relative & |
horiz_resizing = | expand & |
vert_resizing = | expand & |
location = | location = 0,0 & |
height = | 0.5 & |
width = | 0.5 & |
label = | button_label & |
icon_file = | "C:\ images.jpg" & |
commands = | "interface dialog display dialog=.gui.info_window" & |
dbl_commands = | "interface dialog display dialog=.gui.about_adams" & default = true |
Description:
Parameter | Value Type | Description |
|---|
push_button_name | A New GI_push_btn | Specifies the name of an existing push button |
new_push_button_name | A New GI_push_btn | Specifies a new name for an existing push button |
enabled | Boolean | Activates the push button |
help_text | String | Specifies the help text |
documentation_text | String | Specifies the documentation text |
units | Int_units | Specifies the push button size in pixels or units relative to Adams window |
horiz_resizing | Int_H_Resize | Specifies the attachment and scaling option for push button |
vert_resizing | Int_V_Resize | Specifies the attachment and scaling option for push button |
location | Real | Specifies the location of the push button |
height | Real | Specifies the height of the push button in terms of relative units or pixels |
width | Real | Specifies the width of the push button in terms of relative units or pixels |
label | String | Specifies label of the push button |
icon_file | String | Specifies the name and location of the image for icon |
commands | String | Specifies the command to be executed with a single click |
dbl_commands | String | Specifies the command name to be executed with a double-click |
default | True_False | Set the current status for parameter ‘dbl_command’ |
Extended Definition:
1. The push button has a command associated with it, which is created if the push button with specified name. The parameter ‘Enable’ activates the push button depending on the Boolean value, which is either yes or no. The name of the existing push button can be changed by specifying the ‘new_push_button_name’
2. If the parameter ‘Enabled’ is set to ON, the menu will be preactivated.
3. The pop-up help and documentation help can be specified in appropriate dialog boxes.
4. The size of the info window can be specified in terms of the number of pixels. Alternatively, the size can also be stated as relative to the Adams window
5. The vertical and horizontal resizing options are used to adjust the placement of the option menu on existing dialog box. For example, attach_left; attach_top options for Horiz_resizing and Vert_resizing will place the option menu 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’
6. The size of the option menu 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 information window to be half as high as the Adams View window.
7. The label which should appear on the button is specified by the parameter, ‘label’.
Specify the name of the file that contains the icon definition for use on an iconic menu. If an icon file is selected for the push button, the image will appear on the button instead of the string,‘label’. Its placement depends on where the axis is placed. The label can be of unlimited length, but may not all fit on the plot if it is very long. If the string contains spaces, it must be enclosed in quotation marks.
8. The parameter ‘command’ specifies the command to be executed by clicking the push button. You can also specify a different command for double-clicking the push button. Thus, the push button can execute two different commands, depending upon single or double click.