Programmer Guide/Shell Items/Display/DISPLAY Item Attributes: Difference between revisions
From STX Wiki
< Programmer Guide | Shell Items | Display
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:{{SUBPAGENAME}}}} | {{DISPLAYTITLE:{{SUBPAGENAME}}}} | ||
{{Display Item}} | |||
The [[Programmer_Guide/Shell_Items/Display|display item]] has the following attributes, which can be accessed using the following syntax: | The [[Programmer_Guide/Shell_Items/Display|display item]] has the following attributes, which can be accessed using the following syntax: | ||
| Line 20: | Line 21: | ||
| <code>!WINDOW</code> | | <code>!WINDOW</code> | ||
| N/A | | N/A | ||
| <code>xpos ypos width height</code> indicating the position (upper left corner) and size in pixels of the display window | | <code>xpos ypos width height</code> indicating the position (upper left corner) and size in pixels of the display window relative to the primary monitor origin. | ||
|- | |- | ||
| <code>!TITLE</code> | | <code>!TITLE</code> | ||
| Line 64: | Line 65: | ||
| <code>!DIALOGMODE</code> | | <code>!DIALOGMODE</code> | ||
| N/A | | N/A | ||
| <code>NOWINDOW</code>, | | <code>NOWINDOW</code>, <code>HIDDEN</code>, <code>VISIBLE</code> or <code>ENABLED</code> indicating the mode fo mode of the dialog window (<code>NOWINDOW</code> … not created) | ||
|- | |- | ||
| <code>!DIALOGALIGN</code> | | <code>!DIALOGALIGN</code> | ||
| N/A | | N/A | ||
| <code>ABOVE</code>, <code | | <code>ABOVE</code>, <code>BELOW</code>, <code>LEFT</code> or <code>RIGHT</code>, indicating the position of the dialog window | ||
|- | |- | ||
| <code>!ONTOP</code> | | <code>!ONTOP</code> | ||
| Line 76: | Line 77: | ||
| <code>!FOREGROUND</code> | | <code>!FOREGROUND</code> | ||
| N/A | | N/A | ||
|Returns | |Returns <code>1</code> if the display is currently the foreground window. Returns <code>0</code> if the display is currently not the foreground window. Returns <code>-1</code> if the display is currently not a window. | ||
|} | |} | ||
Latest revision as of 10:34, 28 April 2015
| Display Item | |||||
|---|---|---|---|---|---|
| INTRODUCTION | NEW | SET | ATTRIBUTES | MESSAGES | EXAMPLES |
The display item has the following attributes, which can be accessed using the following syntax:
#result := $#display[!ATTRIBUTE]
| Attribute | Argument | Value(s) and Description |
|---|---|---|
!MODE
|
N/A | NOWINDOW, HIDDEN, VISIBLE or ENABLED, indicating the mode of the display window
|
!STYLE
|
N/A | NOWINDOW, MINIMIZED, RESTORED or MAXIMIZED indicating the style of the display window
|
!WINDOW
|
N/A | xpos ypos width height indicating the position (upper left corner) and size in pixels of the display window relative to the primary monitor origin.
|
!TITLE
|
N/A | title (caption) of the display window |
!NROWS
|
N/A | number of rows for graphs |
!NCOLS
|
N/A | number_of_cols0 number_of_cols1 … showing the number of colums (1 or 2) per row
|
!HROWS
|
N/A | height_of_row0 height_of_row1 … showing the current relative row height (all row heights summing up to 1)
|
!WCOLS
|
N/A | width_of_col0 width_of_col1 … showing the current relative position (0…1) of column splitters; a position value is only valid if the row is split.
|
!GRAPHS
|
N/A | number of graph items attached to the display |
!GRAPH
|
index | name_of_graph_object row_index col_indexget info about attached graph item identified by index (0, 1, ...) |
!ACTIVEGRAPH
|
N/A | name_of_active_graph_objectname of currently activated (focused) graph item |
!FULLSCREEN
|
N/A | fullscreen_statusquery fullscreen mode flag (1…fullscreen, 0…window)
|
!DIALOGITEM
|
N/A | name_of_dialog_objectget name of (1st) dialog item attached to the display item |
!DIALOGMODE
|
N/A | NOWINDOW, HIDDEN, VISIBLE or ENABLED indicating the mode fo mode of the dialog window (NOWINDOW … not created)
|
!DIALOGALIGN
|
N/A | ABOVE, BELOW, LEFT or RIGHT, indicating the position of the dialog window
|
!ONTOP
|
N/A | always on top status, querying whether the display is in the always on top mode |
!FOREGROUND
|
N/A | Returns 1 if the display is currently the foreground window. Returns 0 if the display is currently not the foreground window. Returns -1 if the display is currently not a window.
|
