View source for Programmer Guide/Shell Items/Display/SET DISPLAY

{{DISPLAYTITLE:{{SUBPAGENAME}}}}
This chapter documents the <code>SET display</code> family of commands applicable to {{STX}} [[Programmer_Guide/Shell_Items/Display|<code>DISPLAY</code> items]] (i.e. shell items of type <code>DISPLAY</code>).

 SET <var>display</var> <var>subcommand</var> &hellip;

For a list of <code>DISPLAY</code> item attributes, see [[Programmer Guide/Shell Items/Display/DISPLAY Item Attributes|DISPLAY Item Attributes]]. For a short first introduction into the matter of <code>DISPLAY</code> items, see [[Programmer_Guide/Shell_Items/Display/Introducing_Display_Items|Introducing Display Items]].

== Graph Control ==

The following commands are used to set the height and width of the window in which a graph is displayed, as well as assigning the graph itself.

===GRAPH===

 SET <var>display</var> GRAPH <var>graphitemname</var>

Activate a graph attached to the display. The activated graph gets the keyboard focus.

===HEIGHT===

 SET <var>display</var> HEIGHT <var>h1</var> [.. <var>hNrows</var>]

Set the height of all graph rows relative to one another. The height of the display window and of the dialog is not changed. E.g. <code>SET display HEIGHT 1 1 2</code> sets the height of row three to the double of the height of rows one and two.

;<var>hX</var>

:The relative height of the row <var>X</var> (1 .. number of rows).

===WIDTH===

 SET <var>display</var> WIDTH <var>row</var>|<var>* left right</var>

Set the width of the columns of the specified row (<var>row</var> ³ <code>0</code>) or all split rows (<var>row</var> = <code>*</code>). The column splitter position is computed using:

pos = left / (left + right) . display_window_width.

;<var>left</var>

:The relative width of the left column (<var>left</var> >= 0).

;<var>right</var>

:The relative width of the right column (<var>right</var> >= 0).

== Graph defaults ==
The following settings are not directly used by the [[Programmer_Guide/Shell_Items/Display|display]]. They define the default settings for graphs which are created after the display. For a detailed description see the section [[Programmer_Guide/Shell_Items/Graph/SET_GRAPH|<code>SET GRAPH</code>]]. Only the argument <var>title</var> (of <code>SET display TITLE</code>) is actually used by the display as the window caption (the text in the top left corner of the window).

 SET <var>display</var> AXIS <var>xLabel yLabel labelFont labelColor xTitle yTitle titleFont titleColor xUnit yUnit xBorder yBorder</var>
 SET <var>display</var> FRAME <var>xscale</var> <var>yscale</var> <var>scalecolor</var> <var>grid</var> <var>gridcolor</var> <var>xsteps</var> <var>ysteps</var> <var>major</var> <var>minor</var>
 SET <var>display</var> MARKERS <var>mode</var> <var>auto</var> <var>font</var> <var>color</var> <var>msfont</var> <var>mslincol</var> <var>msfillcol</var> <var>mstextcol</var>
 SET <var>display</var> BGCOLOR <var>text</var> <var>draw</var><
 SET <var>display</var> TITLE <var>mode</var> <var>font</var> <var>color</var> [<var>title</var>]

==Popup Menus==

===ADDPOPUP===

 SET <var>display</var> ADDPOPUP <var>title item1 item2</var> &hellip;
 SET <var>display</var> ADDPOPUP <var>title table</var> /Table

Add a popup menu to the display. The popup menus are displayed in the menu bar of the window in the same order as the <code>ADDPOPUP</code> commands are issued. Here is an example.

[[File:5662.gif]]

When a user selects an entry from one of these popups, the display item is sent a <code>[[Programmer Guide/Shell Items/Dialog/DISPLAY and DIALOG Messages|POPUP]]</code> message.

;<var>title</var>

:The menu title which is displayed in the menu bar of the display.

;<var>itemX</var>

:The menu items. <var>itemX</var> is used as the menu item capture unless the following applies:

:The string <var>itemX</var> is an asterisk - a menu separator is added rather than a caption.

:The string <var>itemX</var> begins with the character '<code>></code>' (e.g. <code>>text</code>) - A submenu is defined using <code>text</code> as the caption.
The string <var>itemX</var> is the character '<code><</code>' - the last opened submenu is closed.

:If you want to display a hotkey in the menu item, add a tab and the hotkey to the item text, e.g. "Open [tab] Ctrl+O".

;<var>table</var>

:A simple table with one item per entry. See <var>itemX</var> for item details.

Separators or items which start or end a submenu are not counted in the menu item index computation!=====SETPOPUP=====

<code>SET <var>display</var> SETPOPUP <var>index1</var> [...] [/Enable|Disable /Check|Uncheck]</code>

Activate|deactivate and/or set|clear the check status of menu items. The items may be located in different menus.

The index of menu items is used in the message handling and for the <code>SETPOPUP</code> command. It is computed as follows:

<var>index</var> <code>= menuIndex * 100 + itemindex</code>

{|
|-
|<code>menuindex</code>
|index of menu (0, 1, ..; leftmost = 0)
|-
|<code>itemindex</code>
|index of item in addressed menu (0, 1, ..; topmost = 0); separators and submenu headers are not counted
|}



===DELETEPOPUP===

 SET display DELPOPUP|DELETEPOPUP

Delete all popup menus and hide the menu bar.