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

interface dialog_box modify

Allows you to modify an existing dialog box window.
The dialog box is a blank interface window created where various buttons and option menus can be placed. The size and editing capabilities are modified by this command for the dialog box.

Format:

 
interface dialog_box modify
dialog_box_name =
an existing GI_dbox
new_dialog_box_name =
a new GI_dbox
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
title =
string
icon_label =
string
start_commnads =
string
finish_commands =
string
execution_commands =
string
decorate =
boolean
resizable =
boolean
width_minimum =
real
width_maximum =
real
height_minimum =
real
height _maximum =
real
grab_all_input =
boolean
iconifiable =
boolean

Example:

 
interface dialog_box modify &
dialog_box_name =
.gui.dgbox &
new_dialog_box_name =
.gui.dgbox2 &
enabled =
yes &
help_text =
text2help &
documentation_text =
text2doc &
units =
relative &
horiz_resizing =
attach_left &
vert_resizing =
attach_top &
location =
0.4,0 &
height =
.4 &
width =
0.4 &
title =
dbox &
icon_label =
minimized_dgbox &
start_commands =
"interface coord_window display=toggle" &
finish_commands =
"view zoom view=.gui.main.front zoom=1.1" &
execution_commands =
"interface dialog display dialog=.gui.about_Adams" &
decorate =
yes &
resizable =
yes &
width_minimum =
0.3 &
width_maximum =
0.6 &
height_minimum =
0.3 &
height_maximum =
0.6 &
grab_all_input =
yes &
iconifiable =
yes

Description:

 
Parameter
Value Type
Description
dialog_box _name
An Existing GI_dbox
Specifies the name of an existing dialog box
new_dialog_box_name
A New GI_dbox
Specifies a new name for an existing dialog box
enabled
Boolean
Activates the info dialog box
help_text
String
Specifies the help text
documentation_text
String
Specifies the documentation text
units
Int_units
Specifies the dialog box window size as pixel or relative to Adams window
horiz_resizing
Int_h_resize
Specifies the attachment and scaling option for dialog box
vert_resizing
Int_v_resize
Specifies the attachment and scaling option for dialog box
location
Real
Specifies the location of the dialog box
height
Real
Specifies the height of the dialog box in terms of relative units or pixel
width
Real
Specifies the width of the dialog box in terms of relative units or pixel
title
String
Specifies the title for the dialog box
iconic_label
String
Specifies the label to appear on a minimized window icon
start_commands
String
Specifies the command associated with the dialog box
finish_commands
String
Specifies the command associated with the dialog box
execution_commands
String
Specifies the command associated with the dialog box
decorate
Boolean
Specifies the peripheral outline decorating for dialog box
resizable
Boolean
Specifies the resizing ability of the dialog box
width_minimum
Real
Specifies the minimum size of the window to be dragged
width_maximum
Real
Specifies the maximum size of the window to be dragged
height_minimum
Real
Specifies the maximum size of the window to be dragged
height_maximum
Real
Specifies the maximum size of the window to be dragged
grab_all_input
Boolean
Specifies the input type
iconifiable
Boolean
Specifies whether the window can be iconified

Extended Definition:

1. The existing dialog box will be renamed if the parameter ‘new_dialog_box_name’ is specified. The dialog box can grab all kinds of interface inputs on the push_button, toggle_button, option menu, and so on. The dialog box is enabled by setting the parameter to yes.
2. The dialog box is displayed by using ‘display’ command
3. The pop-up help and documentation help is be specified for the respective parameters.
4. The size of the dialog box can be specified either in terms of 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 dialog box on existing dialog box. For example, attach_left; attach_top options for Horiz_resizing and Vert_resizing will place the dialog 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 dialog box 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 info window to be one half as high as the Adams View window.
7. Initial height and width of the dialog box appearing on screen can be set by ‘height’ and ‘width’. If the dialog box is made ‘resizable’ it can be dragged to resize. The resizing limits are set by the parameters ‘height_minimum’, ‘height_maximum’, ‘width_minimum’, and ‘width_maximum’ respectively.
8. If the dialog box is made iconifiable, then it can be minimized or maximized by clicking the ‘­_ ‘ and square appearing on upper right corner. Once minimized the icon on the taskbar shows the label set by the parameter ‘iconic_label’
9. The ‘decorate’ parameter if set to ‘no’, it will show a blank dialog box without any peripheral decorating outline.
10.  The ‘start_commands’, ‘finish_commands’, and ‘execution_commands’ are the commands associated with the dialog box, which can be executed explicitly. The ‘start command’ gets executed when the dialog box is displayed, whereas the ‘finish_command’ gets executed when the dialog box is closed and the ‘execute_command’ will be run when the ‘dialog_box execute’ command is run explicitly.