WINDOW PANEL

Define Protected Panel

This directive defines, deletes, and maintains areas within Thoroughbred Basic Windows that are available for terminal input and output, thus protecting the remaining Thoroughbred Basic Window area from any terminal input or output.

Syntax

WINDOW PANEL ( CREATE, width, height, col1, row1, panel-name )
[ attributes ]

WINDOW PANEL ( DELETE, panel-name )

WINDOW PANEL ( SELECT, panel-name )

WINDOW PANEL ( OFF )

CREATE: is a keyword indicating that this directive is used to define a new panel within the currently active Thoroughbred Basic Window.
width: is any positive integer in the range of 1 to the maximum number of columns in the Thoroughbred Basic Window, designating the total width of the panel, including any border.
height: is any positive integer in the range of 1 to the maximum number of rows in the Thoroughbred Basic Window, designating the total height of the panel, including any border.
col1: is any positive integer in the range of 0 to the maximum number of columns in the Thoroughbred Basic Window minus 1, designating the leftmost Thoroughbred Basic Window column in which this panel starts.
row1: is any positive integer in the range of 0 to the maximum number of rows in the Thoroughbred Basic Window minus 1, designating the topmost Thoroughbred Basic Window row in which this panel starts.
panel-name: a string of 1 to 8 characters which names the panel being addressed by this directive.
attributes: describe any additional aspects of the panel such as title, border type, initialization, and so on. The general format for the attributes is "KEYWORD=value" as described in the table in the REMARKS section.
DELETE: is a keyword indicating that this directive is used to remove the designated panel-name definition. If the currently active panel is designated, control is returned to the full Thoroughbred Basic Window and no panels are active. This keyword deletes only the specified panel definition and has no effect on other panels defined.
SELECT: is a keyword indicating that this directive is used to activate the designated panel-name, placing the cursor in the upper left corner of panel-name.
OFF: is a keyword indicating that terminal input and output is permitted to all parts of the currently active Thoroughbred Basic Window. This keyword does not remove the definitions of panels.

Remarks

This directive is generally available starting with release level 8.2.

Before Thoroughbred Basic can execute the WINDOW PANEL directive, The WINDOW CREATE directive must be executed with the PANELCOUNT= option set to a value greater than 0. If you do not specify this option, Thoroughbred Basic will generate an error when it attempts to execute the WINDOW PANEL directive. For more information on the PANELCOUNT= option, please refer to the description of the WINDOW CREATE directive.

Starting with release 8.2, the color setting attributes “INITCOLOR=” and
“BORDERCOLOR=” can have a number value from 0 to 255 as in the Thoroughbred Basic Window directive WINDOW COLOR. Similarly, the attribute setting attributes “INITATR=” and “BORDERCOLOR=” can have a number value from 0 to 15 as in the Thoroughbred Basic Window directive WINDOW ATTR provided the attribute is supported by the setting.

If you use this directive but Thoroughbred Basic Windows is not enabled, an ERR=70 results. For information on how to enable Thoroughbred Basic Windows, please refer to the information on TCONFIG files and IPL files in the chapter on System Files in the Thoroughbred Basic Customization and Tuning Guide.

If this task is configured for Thoroughbred Basic Windows, only the standard set of Thoroughbred Basic terminal mnemonics should be used to send output to the terminal.
Using direct hexadecimal escape sequences to control the terminal screen may cause the Thoroughbred Basic Windows Manager to lose knowledge of cursor position and character attributes. For more information on terminal mnemonics, please refer to the Thoroughbred Basic Customization and Tuning Guide.

The format for attributes is:

Keyword: Description
"BORDER=": describes the border style:

NONE = no border
LG = line graphics box; default
CHAR x = use the character x as the border
CLEAR = defines a border of space characters

"BORDERATR=": sets the attributes of the border:

NV = normal video; default
RV = reverse video
BL = blink
FG = foreground intensity
BG = background intensity

Attributes may be compounded,
e.g.RV+BL+BG = reverse video, blink, background

"TITLE": the title to be placed in the top border row; default is no title; if TITLE= is specified, then the Thoroughbred Basic Window will have a border.
"TITLEAT=": positions the title within the top border row:

LEFT = left justified; default
CENTER = centered
RIGHT = right justified

"INIT=": describes how to initialize the area within the Thoroughbred Basic Window:

NONE = performs no initialization

CHAR x = fills the Thoroughbred Basic Window with the character x

CLEAR = space fills the Thoroughbred Basic Window; default

"INITATR=": describes the initial attributes of the area within the Thoroughbred Basic Window:

NV = normal video; default
RV = reverse video
BL = blink
FG = foreground intensity
BG = background intensity

Attributes may be compounded, e.g.
RV+BL+BG = reverse video, blink, background

"WRAP=": sets autowrap conditions:

YES = wrap from the end of one line to the start of the next line; default

NO = all characters after the last character on a print line are lost

"SCROLL=": sets autoscroll conditions:

YES = scroll screen up one row each time wrap occurs on last Thoroughbred Basic Window position; default.

NO = position cursor at top left whenever wrap occurs on the last Thoroughbred Basic Window position.

"INITCOLOR=": describes the initial color of the area within the Thoroughbred Basic Window. The following are the values used for this attribute:

BACKGR = The color following this value is the background color. If there is no color following this value, then the background color is set to the current background color. Similarly, if the background color is the only one set, then the foreground color is set to the current foreground color:

Color values are: BLACK, BLUE, GREEN, CYAN, RED, MAGENTA, BROWN, LGRAY, GRAY, LBLUE, LGREEN, LCYAN, LRED, LMAGENTA, YELLOW AND WHITE. e.g. BACKGR=RED+YELLOW

“BORDERCOLOR=” sets the color of the border. The following are the values used

for this attribute:

BACKGR = the color following this value is the background color. If there is no color following this value, then the background color is set to the current background color. Similarly, if the background color is the only one set, then the foreground color is set to the current foreground color.

Color values are: BLACK, BLUE, GREEN, CYAN, RED, MAGENTA, BROWN, LGRAY, GRAY, LBLUE, LGREEN, LCYAN, LRED, LMAGENTA, YELLOW AND WHITE. e.g. BACKGR=RED+YELLOW

As stated above, the general format for attributes is “KEYWORD=value”. Multiple attributes can be chained into a single string bounded by quotes (” “) and separated by the vertical bar symbol (called the pipe symbol in UNIX), |. A reverse video, line graphics border could then be represented by the following attribute list (with no embedded spaces):

"BORDER=LG | BORDERATR=RV"

Allowance is also made for use of a separator other than the vertical bar symbol. If the attribute string starts with SEP=character, then that character is interpreted as the separator. Using the example just given, the following string creates the same effect, using the exclamation mark (!) as the separator (again with no embedded spaces):

"SEP= ! BORDER=LG ! BORDERATR=RV"

Examples

WINDOW PANEL ( CREATE, 40, 4, 20, 18, "HELPAREA" )

defines a panel within the current Thoroughbred Basic Window that is 40 columns wide by 4 rows high starting at the Thoroughbred Basic Window’s 21st column and 19th row as the upper left corner of the panel. This panel is named HELPAREA and can be SELECTed or DELETEd by that name.

WINDOW PANEL

Syntax

Remarks

Examples

See also