Programmer Guide/Shell Items/Display/NEW DISPLAY: Difference between revisions
From STX Wiki
< Programmer Guide | Shell Items | Display
Jump to navigationJump to search
m (1 revision: Initial import) |
No edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:{{SUBPAGENAME}}}} | {{DISPLAYTITLE:{{SUBPAGENAME}}}} | ||
This chapter deals with creating {{STX}} [[Programmer_Guide/Shell_Items/Display|<code>DISPLAY</code> shell items]]. | |||
See [[Programmer Guide/Shell Items/Display/SET DISPLAY|SET DISPLAY]] for the SET commands and [[Programmer Guide/Shell Items/Display/DISPLAY Item Attributes|DISPLAY Item Attributes]] for a list of attributes. | See [[Programmer Guide/Shell Items/Display/SET DISPLAY|SET DISPLAY]] for the SET commands and [[Programmer Guide/Shell Items/Display/DISPLAY Item Attributes|DISPLAY Item Attributes]] for a list of attributes. | ||
NEW DISPLAY <var>name caption rows cols1</var> .. <var>colsN</var> [/Style=wdwstyle /Dialog=dlgpos /Floating] [/Joystick /Icon=icon_id /dRop] [ /G ] [ /Owner=$#ownerDisplay [ /Modal ]] | |||
;<var>/ | Create a display item. This is the window (container) for 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. | ||
:If specified in conjunction with a valid /Owner=$#ownerDisplay, this new display disables it's owner whilst it is displayed. If no owner is specified, this option is ignored. | {| class="keinrahmen" | ||
|- | |||
| <var>caption</var> | |||
| The window caption (title). | |||
|- | |||
| <var>rows</var> | |||
| The number of rows used for graphs. | |||
|- | |||
| <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: | |||
* FRAME desktop frame window with system menu; move and resize possible; fullscreen/window switching enabled | |||
* DIALOGBOX: dialog window with system menu; without minimize/maximize; not visible in taskbar; no resize | |||
* MESSAGEBOX: dialog window without system menu and caption not visible in taskbar; no resize | |||
|- | |||
| <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 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 /Owner=$#ownerDisplay, this new display disables it's owner whilst it is displayed. If no owner is specified, this option is ignored. | |||
|} | |||
Revision as of 15:39, 31 October 2012
This chapter deals with creating STx DISPLAY shell items.
See SET DISPLAY for the SET commands and DISPLAY Item Attributes for a list of attributes.
NEW DISPLAY name caption rows cols1 .. colsN [/Style=wdwstyle /Dialog=dlgpos /Floating] [/Joystick /Icon=icon_id /dRop] [ /G ] [ /Owner=$#ownerDisplay [ /Modal ]]
Create a display item. This is the window (container) for 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.
| caption | The window caption (title). |
| rows | The number of rows used for graphs. |
| 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 have the following properties:
|
/Modal
|
If specified in conjunction with a valid /Owner=$#ownerDisplay, this new display disables it's owner whilst it is displayed. If no owner is specified, this option is ignored. |
