Window Mask

A Window Mask object is a special mask object used in User-Layout Data Masks. For free-form windows it is scaled like any other object to the size of the Window Cell. The Window Cell size results from the fixed arrangement of 2 columns and 6 rows and the mask size reported by the VT. Working Sets can participate in these layouts by placing Window Mask objects in the pool.

Attributes

AID
Attribute
Description
Type

The type of the object.

Object Id

Unique identifier of the object. This must be unique within the object pool (2 bytes, 0-65534).

Width

Width of the object in pixels.

Height

Height of the object in pixels.

Window Type

The dimensions given here are width × height in window templates.
0 = Free-form
1 = 1 × 1 Numeric output value with units
2 = 1 × 1 Numeric output value, without units
3 = 1 × 1 String output value
4 = 1 × 1 Numeric input value with units
5 = 1 × 1 Numeric input value, without units
6 = 1 × 1 String input value
7 = 1 × 1 Horizontal linear bar graph, without units
8 = 1 × 1 Single function key
9 = 1 × 1 Dual function key
10 = 2 × 1 Numeric output value with units

Background Colour

Background colour. A colour based on the index of the Colour Palette.

Options (Window Mask)

Optional bits of the Window Mask.

Optional bits:

  • Bit 0 = Available:
    • 0 (FALSE) = This window is currently not available, even if it is defined. The VT does not allow the operator to assign it. If it has already been assigned, the window cell(s) it occupies are displayed empty.
  • Bit 1 = Transparent:
    • If this bit is 1, the background colour attribute is not used and the window is transparent.
  • Bits 2–7: Reserved, set to 0.
Name

Object ID of an Output String object or of an Object Pointer that points to an Output String object containing the string that gives this object a name. The VT may choose to ignore colour and font information and perform the text formatting itself. The VT shall use this name in its proprietary assignment display. The VT must be able to display at least 20 characters.

Window Title

Object ID of an Output String object or of an Object Pointer that points to an Output String object containing the text for the window title. This attribute is required for window types greater than zero. For window type zero, this attribute must be set to the NULL Object ID. For window types greater than zero, the VT may choose to ignore colour and font information and perform the text formatting itself.

Window Icon

Object ID of an output object that contains an icon for the window. The VT may use this icon when formatting window types other than type zero and may also use it in the proprietary mapping screen to represent the window. This attribute may only be NULL if the window type is zero (0). For all other window types, a window icon object must be provided.

Number of Object References to follow

The number of objects required in a Window Mask is variable and depends on the window type. This attribute, although redundant with the window type attribute, allows future extension of this object definition and facilitates parsing.

If the window type is zero (free-form), this attribute must be set to 0. For all other window types, see the tables that follow in clause B.19.2.

Each following attribute is a two-byte reference to an Object ID or the NULL Object ID.

Number of Objects to follow

Number of following objects, even if the value is zero. Each of these objects is contained in this Alarm Mask. Each object consists of 6 bytes: two (2) for the Object ID and four (4) for the position.

Number of Macros to follow

Number of contained macro references, even if it is zero.

Each macro reference consists of 2 bytes: one for the event Id and one for the macro Id.

When the specified event occurs, the associated macro is executed. VT version 5 and later: A reference to a macro with a 16-bit Object Id counts as 2 macro references in the context of this attribute.