25 notebook

notebook symbolizes a real notebook consisting of different pages, the notepages. It is divided up into different sections which are marked by tabs.

This object can be used to make certain basic settings for parameters. Moreover, data can be displayed which can be divided into logical groups.

Definition

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

Events

extevent

focus

help

key

paste

Children

document

notepage

record

transformer

Parent

groupbox

layoutbox

module

notepage

splitbox

toolbar

window

Menu

Pop-up menu

25.1 Attributes

Attribute

RLD

PID

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

.activeobject

object

instance

-,G/-/-

relevant notepage on top

.alignment

integer

(-1, 0, 1)

integer

S,G/D/C

justification of status text of notepage

.backpage

enum

enum

S,G/D/C

corner in which visible borders meet

.bgc

identifier

color

S,G/D/C

background color of notebook

.binding

enum

enum

S,G/D/C

kind of notebook binding, e.g. spiral binding

.bordercolor

identifier

color

S,G/D/C

border color of notebook

.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/-/-

class of object

.control

identifier

instance

-,G/-/-

control the object currently belongs to

.cursor

identifier

cursor

S,G/D/C

cursor belonging to object

.cut_pending

boolean

boolean

S,G/-/-

cut operation not yet carried out

.cut_pending_changed

boolean

boolean

-,G/-/-

changing state during cut operation

.dialog

identifier

instance

-,G/-/-

dialog of object

.direction

integer

integer

S,G/D/C

direction in which the notebook is bound

.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

text color of status line and tabs

.firstchild

object

object

S,G/-/C

accesses the first child object

.firstrecord

object

record

S,G/-/C

accesses the first record of an object

.focus

boolean

boolean

S,G/-/C

input focus on object

.font

identifier

font

S,G/D/C

object font

.function

identifier

func

S,G/D/C

function belonging to object

.groupbox

identifier

instance

-,G/-/-

object groupbox

.height

integer

integer

S,G/D/C

object height

.help

string

identifier

string

text

S,G/D/C

help text of object

.index

integer

index

integer

index

-,G/-/-

current index of object in the child list of its parent

.label

string

string

S,G/D/C

name/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

.majortabheight

integer

integer

S,G/D/C

height of all majortabs (main index)

.majortabwidth

integer

integer

S,G/D/C

width of all majortabs (main index)

.mapped

boolean

boolean

S,G/D/-

defers the display of a visibly created object

.member[integer]

attribute

attribute

-,G/-/-

user-defined attribute [I] of object

.membercount

integer

integer

-,G/-/-

number of user-defined attributes

.menu

identifier

instance

S,G/D/C

object menu

.minortabheight

integer

integer

S,G/D/C

height of all minortabs (side index)

.minortabwidth

integer

integer

S,G/D/C

width of all minortabs (side index)

.model

identifier

instance

S,G/D/C

model belonging to object

.multiline

boolean

boolean

S,G/-/C

multiline edittext

.notepage

object

object

-,G/-/-

notepage which object currently belongs to

.options[enum]

boolean

boolean

S,G/D/-

special options of object

.parent

identifier

instance

S,G/-/-

parent of object

.picheight
(IDM for Windows only)

integer

integer

S,G/D/-

height of the pictures displayed in the tabs for the notepages

.picwidth
(IDM for Windows only)

integer

integer

S,G/D/-

width of the pictures displayed in the tabs for the notepages

.posraster

boolean

boolean

S,G/D/C

positions refer to grid

.real_height

integer

integer

-,G/-/-

real height of object

.real_sensitive

boolean

boolean

-,G/-/-

real selectivity 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

selectivity of object

.sizeraster

boolean

boolean

S,G/D/C

size refers to grid of parent object

.statushelp

string

object

string

text

S,G/-/C

text to be displayed in statusbar

.tabalignment

integer

integer

S,G/D/C

justification of text in tabs

.tabshape

enum

enum

S,G/D/C

shape of major- and minortabs

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

.toolbar

object

object

-,G/-/-

toolbar of object

.toolhelp

string

object

string

text

S,G/D/C

gives a short explanation of object at the cursor

.userdata

anyvalue

anyvalue

S,G/D/C

object userdata (any DM datatype)

.visible

boolean

boolean

S,G/D/C

visibility of object

.width

integer

may be 0

integer

S,G/D/C

actual width of object

.window

identifier

instance

-,G/-/-

window to which object belongs

.xauto

integer

(-1, 0, 1)

integer

S,G/D/C

left position of notebook; the furthest point will be positioned

.xleft

integer

integer

S,G/D/C

right position of notebook; the furthest point will be positioned

.xright

integer

integer

S,G/D/C

x-coordinate, distance from right

.yauto

integer

(-1, 0, 1)

integer

S,G/D/C

definition type of y-coordinates

.ybottom

integer

integer

S,G/D/C

bottom position of notebook; the furthest point will be positioned

.ytop

integer

integer

S,G/D/C

top position of notebook; the furthest point will be positioned

25.2 Specific Attributes

Standard Attributes

Please note that the mouse pointer set with the .cursor is independent of the window system and that it cannot always be set where you want. We therefore recommend to set the mouse pointer for each notepage individually.

Geometry Attributes

.height defines the height of the entire notebook object including all its elements. If the height is set to low, a minimal value depending on the window system will be used instead. The height must not be 0, since the required height cannot be calculated.

.menu: The availability of a popup menu exclusively for the notebook depends on the window system. This is why - if a pop-up menu is required for the notebook - only two variants should be chosen:

  1. a pop-up menu is set for each notepage, but none for the notebook.
  2. a pop-up menu is set for the notebook, but none for the notepages.

If .posraster = true, the notebook will be shifted by a half grid unit (border object!).

If .sizeraster = true, a grid unit will be deducted from the notebook height and width (border object!).

Layout Attributes

The attribute .bgc defines the background color of the notebook.

The attribute .bordercolor (default: 0) defines the border color of the notebook.

Object-specific Attributes

.activeobject defines the active, relevant notepage on top.

.alignment defines the alignment of a status text which every notepage can have (default = 1).

.backpage defines the corner in which the visible page borders meet. "backpage" describes the realization of invisible notepages. The borders of the invisible notepage are displayed in a corner.

.binding defines the way a notebook is to be bound.

.direction specifies the direction which the notebook is oriented to (default = 1, vertically).

.majortabheight defines the height of all majortabs. "majortab" stands for the labeling of a notepage in the main index.

.majortabwidth defines the width of all majortabs.

.minortabheight defines the height of all minortabs. "minortab" stands for the labeling of a notepage in the side index.

.minortabwidth defines the width of all minortabs (side index).

.tabalignment defines how the text is justified in the tabs of the notebook.

.tapshape defines the shape of major- and minortabs.

.width defines the width of the entire notebook object including all its elements. If the width is specified too small, a minimal value independent of the window system is chosen instead. The width must not be 0 because in that case the necessary width cannot be calculated.

25.2.1 backpage

In the following table the effects of the attributes .backpage and .direction on the positioning of major tabs and minor tabs as well as on the binding are shown:

.backpage

.direction

Major Tab

Minor Tab

Binding

bp_bottomright

1

right

bottom

left

bp_bottomright

2

bottom

right

top

bp_bottomleft

1

left

bottom

right

bp_bottomleft

2

bottom

left

top

bp_topright

1

right

top

left

bp_topright

2

top

right

bottom

bp_topleft

1

left

top

right

bp_topleft

2

top

left

bottom

25.3 Keyboard Control

Within the notebook, the keyboard control only affects the child objects of the top notepage, and not - as is usual - all child objects.

A notepage change has to be made by system-dependent keyboard methods.

Whether the notebook is in the focus order also depends on the system.

25.4 Example

dialog D

window W
{
  .active false;
  .width  359;
  .height 243;
  .title  "Beispiel";

  child notebook N
  {
    .xleft  45;
    .width  181;
    .ytop   19;
    .height 150;

    child notepage Np1
    {
      .active true;
      .title  "AAA";
    }

    child notepage Np2
    {
      .title "BBB";
    }

    child notepage Np3
    {
      .title "CCC";
    }
  }
}

Figure 13-31: notebook