Programmer Guide/Shell Items/Display/NEW DISPLAY: Difference between revisions
From STX Wiki
< Programmer Guide | Shell Items | Display
Jump to navigationJump to search
(initial import) |
mNo edit summary |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:{{SUBPAGENAME}}}} | {{DISPLAYTITLE:{{SUBPAGENAME}}}} | ||
{{Display Item}} | |||
A display item can be created using the <code>NEW DISPLAY</code> command. | |||
NEW DISPLAY <var>name</var> <var>caption</var> <var>rows</var> <var>cols<sub>1</sub></var> … <var>cols<sub>N</sub></var> [/Style=<var>wdwstyle</var> /Dialog=<var>dlgpos</var> /Floating] [/Joystick /Icon=<var>icon_id</var> /Rodp] [ /Garbage ] [ /Owner=<var>$#ownerDisplay</var> [ /Modal ]] | |||
< | A display is the container windows for one or more graphs and/or a dialog. The arguments <var>rows</var> (≥0) and <var>cols<sub>1</sub></var>-<var>cols<sub>N</sub></var> (1 or 2) define the number of rows and columns within those rows available for graphs. If <var>rows</var> equals 0 no graphs can be created in the display. The option <code>/Dialog</code> must be specified if a dialog should be contained in the display. Note that the dialog is then created using the [[Programmer_Guide/Shell_Items/Dialog/NEW DIALOG|NEW DIALOG]] command. | ||
{| class="keinrahmen" | |||
|- | |||
| <var>caption</var> | |||
| The window caption (title). | |||
|- | |||
| <var>rows</var> | |||
| The number of rows used for graphs (maximum 20). | |||
|- | |||
| <var>cols<sub>X</sub></var> | |||
| The number of columns (1 or 2) in row X. | |||
|- | |||
| <code>/Joystick</code> | |||
| Enable joystick support. | |||
|- | |||
| <code>/R</code> | |||
| Enable file drag and drop for this window (dRop). | |||
|- | |||
| <code>/Style=<var>wdwstyle</var></code> | |||
| Set the window style of the display; currently the following 3 styles are supported: | |||
{| class="keinrahmen" | |||
|- | |||
| <code>FRAME</code> || desktop frame window with system menu; move and resize possible; fullscreen/window switching enabled | |||
|- | |||
| <code>DIALOGBOX</code> || dialog window with system menu; without minimize/maximize; not visible in taskbar; no resize | |||
|- | |||
| <code>MESSAGEBOX</code> || dialog window without system menu and caption not visible in taskbar; no resize | |||
|} | |||
DIALOGBOX | |- | ||
MESSAGEBOX | | <code>/Dialog=<var>dlgpos</var></code> | ||
| Enables dialog and sets the dialog window default position (<code>ABOVE</code>, <code>BELOW</code>, <code>LEFT</code> or <code>RIGHT</code>) inside the display; the position can be changed via macro commands if dialog is not a floating window. | |||
|- | |||
| <code>/Floating</code> | |||
| The dialog is a floating window; user can drag/dock window. | |||
|- | |||
| <code>/Icon=<var>icon_id</var></code> | |||
| One of a number of icons can be specified (see Appendix). If this option is not used, the standard icon will be used. | |||
|- | |||
| <code>/Garlic</code> | |||
| Garbage collection. If specified, the item is automatically deleted when exiting the macro. | |||
|- | |||
| <code>/Owner=<var>$#ownerDisplay</var></code> | |||
| If you want this display to have an owner, use this flag and pass a display or dialog item. Owned windows (we like to think of them as ''possessed windows'') have the following properties: | |||
# the owned window is ''always'' above the owner in the z-order, | |||
# the owned window is destroyed with the owner by the system | |||
# the owned window is hidden when the owner is minimized | |||
|- | |||
| <code>/Modal</code> | |||
| If specified in conjunction with a valid <code>/Owner=<var>$#ownerDisplay</var></code>, this new display disables its owner whilst it is being displayed. If no owner is specified, the <code>/Modal</code> option is ignored. | |||
|} | |||
Latest revision as of 08:58, 11 May 2015
| Display Item | |||||
|---|---|---|---|---|---|
| INTRODUCTION | NEW | SET | ATTRIBUTES | MESSAGES | EXAMPLES |
A display item can be created using the NEW DISPLAY command.
NEW DISPLAY name caption rows cols1 … colsN [/Style=wdwstyle /Dialog=dlgpos /Floating] [/Joystick /Icon=icon_id /Rodp] [ /Garbage ] [ /Owner=$#ownerDisplay [ /Modal ]]
A display is the container windows for one or more graphs and/or a dialog. The arguments rows (≥0) and cols1-colsN (1 or 2) define the number of rows and columns within those rows available for graphs. If rows equals 0 no graphs can be created in the display. The option /Dialog must be specified if a dialog should be contained in the display. Note that the dialog is then created using the NEW DIALOG command.
| caption | The window caption (title). | ||||||
| rows | The number of rows used for graphs (maximum 20). | ||||||
| colsX | The number of columns (1 or 2) in row X. | ||||||
/Joystick
|
Enable joystick support. | ||||||
/R
|
Enable file drag and drop for this window (dRop). | ||||||
/Style=wdwstyle
|
Set the window style of the display; currently the following 3 styles are supported:
| ||||||
/Dialog=dlgpos
|
Enables dialog and sets the dialog window default position (ABOVE, BELOW, LEFT or RIGHT) inside the display; the position can be changed via macro commands if dialog is not a floating window.
| ||||||
/Floating
|
The dialog is a floating window; user can drag/dock window. | ||||||
/Icon=icon_id
|
One of a number of icons can be specified (see Appendix). If this option is not used, the standard icon will be used. | ||||||
/Garlic
|
Garbage collection. If specified, the item is automatically deleted when exiting the macro. | ||||||
/Owner=$#ownerDisplay
|
If you want this display to have an owner, use this flag and pass a display or dialog item. Owned windows (we like to think of them as possessed windows) have the following properties:
| ||||||
/Modal
|
If specified in conjunction with a valid /Owner=$#ownerDisplay, this new display disables its owner whilst it is being displayed. If no owner is specified, the /Modal option is ignored.
|
