38 statusbar

The statusbar is used to display status information and helptexts. It is situated at the bottom line of the window and will not alter the size of the work area. The frame window is enlarged by the statusbar.

Definition

{ export | reexport } { model } statusbar { <Identifier> }
{
  <standard attributes>
  <plain attributes>
  <geometry attributes>
  <hierarchy attributes>
  <layout attributes>
  <text attributes>
  <object-specific attributes>
}

Events

extevent

Children

document

image

progressbar

record

statictext

transformer

Parent

module

window

Menu

none

38.1 Attributes

Attribute

RSD

PSD

Properties

Short Description

.acc_label

string

object

string

text

S.G/D/C

overwrites the Automation Identifier for Microsoft UI Automation

.acc_text

object

string

text

string

S.G/D/C

overwrites the Automation Name for Microsoft UI Automation

.borderstyle

enum

enum

S,G/D/C

defines the style, i.e. representation and characteristics of the borders (since IDM version A.06.01.a)

.child[integer]

object

object

S,G/-/C

accesses the I-th child object

.childcount

integer

integer

-,G/-/-

queries the number of child objects

.class

class

class

-,G/-/-

object class

.control

identifier

instance

-,G/-/-

control the object currently belongs to

.dialog

identifier

instance

-,G/-/-

dialog for object

.document[integer]

object

document

S,G/-/-

accesses the I-th XML Document

.external

boolean

boolean

-,G/-/-

returns if the object class is an USW class

.external[integer]

class

class

-,G/-/-

returns the I-th registered USW class

.fgc

identifier

color

S,G/D/C

foreground color of object

.firstchild

object

object

S,G/-/C

accesses the first child object

.firstrecord

object

record

S,G/-/C

accesses the first record of an object

.font

identifier

font

S,G/D/C

font of object

.helppos

integer

integer

S,G/D/C

position of helptext

.height

integer

integer

S,G/D/C

will be ignored

.index

integer

integer

-,G/-/-

current index of object in the children list of its parent

.label

string

string

S,G/D/C

identifier of object

.lastchild

object

object

S,G/-/C

accesses the last child object

.lastrecord

object

record

S,G/-/C

accesses the last record of an object

.layoutbox

object

object

-,G/-/-

layoutbox of object

.mapped

boolean

boolean

S,G/D/-

defers the display of a visibly created object

.member[integer]

attribute

attribute

-,G/-/-

i-th user-defined attribute of object

.membercount

integer

integer

-,G/-/-

number of user-defined attributes

.model

identifier

instance

S,G/D/C

model belonging to the object

.parent

identifier

instance

S,G/-/-

parent of object

.real_height

integer

integer

-,G/-/-

real height of object

.real_visible

boolean

boolean

-,G/-/-

real visibility of object

.real_width

integer

integer

-,G/-/-

real width of object

.record[integer]

object

record

S,G/-/C

accesses the I-th record of an object

.recordcount

integer

integer

-,G/-/-

queries the number of child records

.scope

integer
(1, 2, 3)

scope

-,G/-/-

queries the object type (Default, Model or instance)

.sensitive

boolean

boolean

S,G/D/C

selectability of object, is always false

.sizeraster

boolean

boolean

S,G/D/C

size refers to the raster of parent object

tile

object

tile

S,G/D/C

tile resource used as background image

.tilestyle

enum

enum

S,G/D/C

controls how the background image set in .tile is arranged
.toolhelp

text

text

S,G/-/-

specified text to be displayed in pop-up

.userdata

anyvalue

anyvalue

S,G/D/C

userdata of object of any data type

.visible

boolean

boolean

S,G/D/C

visibility of object

.vsb_visible

boolean

boolean

S,G/D/C

visibility of vertical scrollbar

.window

identifier

instance

-,G/-/-

window the object currrently belongs to

38.2 Specific Attributes

Statusbars can be used in top-level windows and child windows. If a child window has no visible statusbar, statushelp texts will be displayed in the statusbar of the parent window (if available).

The helptexts are set in the corresponding objects with the attribute .statushelp. The helptexts will be displayed if a menu is being selected or if the mouse is being moved to an object.

Only statictexts are valid as child objects. The attribute .width of the statictext specifies whether the statustext will be flat, sunken or raised. The texts will be displayed in the order of the children from the left to the right with the width specified in .width. The last child is enlarged up to the right margin. To avoid this you can add a dummy.

A special feature of the statictexts in the statusbar is the possibility to position texts with "\t".

The following graphic shows the schematic structure of a statusbar:

Figure 13-41: Schematic structure of a statusbar

A statusbar consists of up to 255 text fields which can either be connected to or separated from each other. In front of the first and after the last text field there is a "separation". The text is left-aligned within a text field. The "separation" between two text fields has the width of one raster unit, if the raster is switched on, otherwise the width will depend on the system.

The statusbar can also display a helptext. This helptext can overlap all or several children, with the result that important information is still visible.

Figure 13-42: Display of helptext in a statusbar

Geometry Attributes

The usual geometry attributes (width, height, position) will all be ignored, as the position of the statusbar is invariable. The statusbar is situated at the bottom line of the window, below the horizontal scrollbar if available. The statusbar extends over the entire window width; its height is defined by the indicated font.

The statusbar is not scrolled along with the window contents. This is why you have to note that the statusbar information remains visible in its totality. When calculating the geometry of the window the statusbar is not considered as a part of the window contents like the scrollbar but of the window frame.

Only the attributes .xraster and .yraster will be considered as they are useful when calculating the position of children.

Standard Attributes

Only the standard attribute .visible is considered. With this attribute the statusbar can be made visible or invisible. The attribute .sensitive is ignored as the statusbar is not selectable.

Layout Attributes

.borderstyle

Attribute is supported, but only border_none and border_toolkit are permitted. border_plain, border_raised and border_sunken are mapped to border_toolkit.

.font

The font to be used for the text display is defined with the attribute .font. Fonts which have been defined at the corresponding objects will be ignored.

Specific Attributes

.helppos: This attribute indicates in which position the helptext .statushelp (see below) is to be displayed. 0 (default) defines a full-line representation of the help information. The value n defines the representation of the helptext via all children up to the n‑th child. If the value is <0 no help information will be displayed. This attribute may vary from window system to window system. The values 0 and -1 can always be set and will be displayed according to the description above.

.sizeraster: This attribute is used to calculate the sizeraster of the fields within the statusbar. The following values are valid:

38.3 Example

Window with statusbar which may be changed by window settings.

window W
{
  .width   400;
  .height  200;
  .vwidth  400;
  .vheight 200;
  .hsb_visible true;
  .vsb_visible true;
  .title   "statbartest";

  child statictext StHelppos
  {
    .xleft 200;
    .ytop  80;
    .text  ".helppos";
  }

  child statictext Sw
  {
    .yauto   -1;
    .ybottom 0;
    .text    "Text unten";
    .depth   1;
  }
  ...
  child statusbar S
  {
    child statictext St0
    {
      .width 0;
      .text  "text 0";
      .depth 0;
    }

    child statictext St1
    {
      .width 0;
      .text  "Text 1";
      .depth -1;
    }

    child statictext St2
    {
      .width 120;
      .text  "links\tmitte\trechts";
      .depth 1;
    }

    child statictext St3
    {
      .width 100;
      .text  "";
      .depth 0;
    }
  }
}

Figure 13-43: Fenster mit statusbar-

Figure 13-44: window with statusbar