Programmer Guide/Shell Items/Display/DISPLAY Item Attributes: Difference between revisions

From STX Wiki
Jump to navigationJump to search
(initial import)
 
No edit summary
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
==DISPLAY Item Attributes==
{{Display Item}}
The [[Programmer_Guide/Shell_Items/Display|display item]] has the following attributes, which can be accessed using the following syntax:
 
#result := $#display[!ATTRIBUTE]


{|
{|
|- class="keinrahmen"
! Attribute
! Argument
! Value(s) and Description
|-
|-
|Attribute<nowiki>-</nowiki>Id
| <code>!MODE</code>
|Sub<nowiki>-</nowiki>Id
| N/A
|Value(s) and Description
|<code>NOWINDOW</code>, <code>HIDDEN</code>, <code>VISIBLE</code> or <code>ENABLED</code>, indicating the mode of the display window
|-
|!MODE
|<nowiki>-</nowiki>
|NOWINDOW<nowiki>|</nowiki>HIDDEN|VISIBLE|ENABLEDmode of the display window
|-
|-
|!STYLE
| <code>!STYLE</code>
|<nowiki>-</nowiki>
| N/A
|NOWINDOW<nowiki>|</nowiki>MINIMIZED|RESTORED|MAXIMIZEDstyle of the display window
| <code>NOWINDOW</code>, <code>MINIMIZED</code>, <code>RESTORED</code> or <code>MAXIMIZED</code> indicating the style of the display window
|-
|-
|!WINDOW
| <code>!WINDOW</code>
|<nowiki>-</nowiki>
| N/A
|xpos ypos width heightposition (upper left corner) and size of the display window in pixels
| <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.
|-
|-
|!TITLE
| <code>!TITLE</code>
|<nowiki>-</nowiki>
| N/A
|titletitle (caption) of the display window
| title (caption) of the display window
|-
|-
|!NROWS
| <code>!NROWS</code>
|<nowiki>-</nowiki>
| N/A
|number_of_rowsnumber of rows for graphs
| number of rows for graphs
|-
|-
|!NCOLS
| <code>!NCOLS</code>
|<nowiki>-</nowiki>
| N/A
|number_of_cols0 number_of_cols1 ...number of colums (1 or 2) per row
| <code>number_of_cols<sub>0</sub> number_of_cols<sub>1</sub> &hellip;</code> showing the number of colums (1 or 2) per row
|-
|-
|!HROWS
| <code>!HROWS</code>
|<nowiki>-</nowiki>
| N/A
|height_of_row0 height_of_row1 ...the current relative row height (sum = 1)
| <code>height_of_row<sub>0</sub> height_of_row<sub>1</sub> &hellip;</code> showing the current relative row height (all row heights summing up to 1)
|-
|-
|!WCOLS
| <code>!WCOLS</code>
|  
| N/A
|width_of_col0 width_of_col1 ...the current relative position (0..1) of column splitters; a position value is only valid if the row is split.
| <code>width_of_col<sub>0</sub> width_of_col<sub>1</sub> &hellip;</code> showing the current relative position (0&hellip;1) of column splitters; a position value is only valid if the row is split.
|-
|-
|!GRAPHS
| <code>!GRAPHS</code>
|<nowiki>-</nowiki>
| N/A
|number_of_attached_graphsnumber of graph items attached to the display
| number of graph items attached to the display
|-
|-
|!GRAPH
|<code>!GRAPH</code>
|index
|<var>index</var>
|name_of_graph_object row_index col_indexget info about attached graph item identified by index (0, 1, ...)
|name_of_graph_object row_index col_indexget info about attached graph item identified by index (0, 1, ...)
|-
|-
|!ACTIVEGRAPH
| <code>!ACTIVEGRAPH</code>
|<nowiki>-</nowiki>
| N/A
|name_of_active_graph_objectname of currently activated (focused) graph item
|name_of_active_graph_objectname of currently activated (focused) graph item
|-
|-
|!FULLSCREEN
| <code>!FULLSCREEN</code>
|<nowiki>-</nowiki>
| N/A
|fullscreen_statusquery fullscreen mode flag (1=fullscreen, 0=window)
|fullscreen_statusquery fullscreen mode flag (<code>1</code>&hellip;fullscreen, <code>0</code>&hellip;window)
|-
|-
|!DIALOGITEM
| <code>!DIALOGITEM</code>
|<nowiki>-</nowiki>
| N/A
|name_of_dialog_objectget name of (1st) dialog item attached to the display item
|name_of_dialog_objectget name of (1st) dialog item attached to the display item
|-
|-
|!DIALOGMODE
| <code>!DIALOGMODE</code>
|<nowiki>-</nowiki>
| N/A
|NOWINDOW<nowiki>|</nowiki>HIDDEN|VISIBLE|ENABLEDmode of dialog-window (NOWINDOW = not created)
| <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> &hellip; not created)
|-
|-
|!DIALOGALIGN
| <code>!DIALOGALIGN</code>
|<nowiki>-</nowiki>
| N/A
|ABOVE<nowiki>|</nowiki>BELOW|LEFT|RIGHTposition of dialog-window
| <code>ABOVE</code>, <code>BELOW</code>, <code>LEFT</code> or <code>RIGHT</code>, indicating the position of the dialog window
|-
|-
|!ONTOP
| <code>!ONTOP</code>
|<nowiki>-</nowiki>
| N/A
|always on top statusquery whether display is in the 'always on top' mode
|always on top status, querying whether the display is in the ''always on top'' mode
|-
|-
|!FOREGROUND
| <code>!FOREGROUND</code>
|<nowiki>-</nowiki>
| N/A
|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.
|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.
Retrieved from "https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?title=Programmer_Guide/Shell_Items/Display/DISPLAY_Item_Attributes&oldid=7382"

Navigation menu

Personal tools