interface container create
Allows you to create a new container on an existing dialog box.
The container is a submenu on the dialog box, which can collect other interface objects like buttons, option menus, sliders and so on. The container can be used to segregate and ‘contain’ a set of menus and buttons on the dialog box.
The container size and location is decided by this command.
Format:
interface container create |
|---|
container_name = | a new GI_container |
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 |
start_commands = | string |
finish_commnads = | string |
sash_type = | sash_type |
position_of_sash = | real |
tab_label = | string |
Example:
interface container create & |
container_name = | .gui.dgbox.cntr & |
enabled = | yes & |
help_text = | "text2help" & |
documentation_text = | "txt2doc" & |
units = | relative & |
horiz_resizing = | attach_left & |
vert_resizing = | attach_top & |
location = | 0.0, 0.0 & |
height = | .4 & |
width = | .4 & |
start_commands = | "view center view=.gui.main.front object=431.34, 7.4886913511, 0.0" & |
finish_commands = | "view center view=.gui.main.front object=-431.34, -7.4886913511, 0.0" & |
execution_commands = | "view zoom view=.gui.main.front zoom=2." & |
sash_type = | horizontal & |
position_of_sash = | 0.9 & |
tab_label = | "contain" |
Description:
Parameter | Value Type | Description |
|---|
container_name | A New GI_container | Specifies the name for a new container to be created |
enabled | Boolean | Activates the container |
help_text | String | Specifies the help text |
documentation_text | String | Specifies the documentation text |
units | Int_units | Specifies the container size as pixel or relative to Adams window |
horiz_resizing | Int_h_resize | Specifies the attachment and scaling option for the container |
vert_resizing | Int_v_resize | Specifies the attachment and scaling option for the container |
location | Real | Specifies the location of the container on the dialog box |
height | Real | Specifies the height of the container in terms of relative units or pixel |
width | Real | Specifies the width of the container field in terms of relative units or pixel |
start_commands | String | Specifies the command associated with the container |
finish_commands | String | Specifies the command associated with the container |
execution_commnads | String | Specifies the command associated with the container |
sash_type | Sash_type | Specifies the type of sash |
position_of_sash | Real | Specifies the position of sash |
tab_label | String | Specifies the label of the container |
Extended Definition:
1. The preliminary parameters of the container like size, associated commands and editing capability are set using this command.
2. The pop-up help and documentation help can be specified initially.
3. The size of the container 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 container menu on existing dialog box. For example, attach_left; attach_top options for Horiz_resizing and Vert_resizing will place the container 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 container window can be specified with respect to the dialog box size 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 dialog window. Therefore, a value of 1.0 will set the container field window to be one half as high as the dialog box.
6. Each of the parameters start, finish and execution commands specifies the command associated with the container. Each of these command will get executed for specific event. The command ‘display container’ will execute the associated ‘start command’. The command ‘undisplay container’ will execute associated ‘finish command’. The associated ‘execute command’ is executed explicitly by running the ‘container execute command’.
7. You may want to expand the width, height of the container so you have more space for entering the text. To expand the container, point to the sash on its border. When the cursor changes to a double-sided arrow, drag the cursor to increase the container size. The value for ‘position_of_sash’ is 0.0 to 1.0.