13 groupbox

The groupbox is an auxiliary object which defines a subordinate logical structure in the object hierarchy. All objects defined in a groupbox are on the same logical level. The groupbox has to be used if several groups of radiobuttons are to be realized in one window. Moreover the groupbox can always be used if objects of any kind are to be grouped.

Definition

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

Events

extevent

help

hscroll

key

paste

scroll

select

vscroll

Children

canvas

checkbox

document

edittext

groupbox

image

layoutbox

listbox

notebook

poptext

pushbutton

radiobutton

record

rectangle

scrollbar

spinbox

splitbox

statictext

tablefield

transformer

treeview

Parent

groupbox

layoutbox

module

notepage

splitbox

toolbar

window

Menu

Pop-up menu

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

.accelerator

identifier

accel

S,G/D/C

accelerator of object

.bgc

identifier

color

S,G/D/C

background color

.bordercolor

identifier

color

S,G/D/C

border color

.borderraster

boolean

boolean

S,G/D/-

controls computation of geometry with active grid

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

.borderwidth

integer

integer

S,G/D/C

border width

.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/id of object

.control

identifier

instance

-,G/-/-

control currently belonging to object

.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 to which the object belongs

.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

.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

.focus_on_click

boolean

boolean

S,G/-/- defines if a mouse click into an object’s client area activates the object

.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

.hsb_arrows

boolean

boolean

S,G/-/-

defines whether horizontal scrollbar has arrows at its end

.hsb_linemotion

integer

integer

S,G/D/C

horizontal scroll value for scrolling line by line

.hsb_optional

boolean

boolean

S,G/D/C

horizontal scrollbar is only displayed if necessary

.hsb_pagemotion

integer

integer

S,G/D/C

horizontal scroll value for scrolling page by page

.hsb_visible

boolean

boolean

S,G/D/C

visibility of horizontal scrollbar

.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

.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

.model

identifier

instance

S,G/D/C

model belonging to object

.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

.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

.real_x

integer

integer

-,G/-/-

real distance from left (in pixel)

.real_xraster

integer

integer

-,G/-/-

width of the grid internally used

.real_y

integer

integer

-,G/-/-

real distance from top (in pixel)

.real_yraster

integer

integer

-,G/-/-

height of the grid internally used

.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

.reffont

identifier

font

S,G/D/C

reference font of object

.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

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)

.vheight

integer

integer

S,G/D/C

internal (virtual) height

.visible

boolean

boolean

S,G/D/C

visibility of object

.vsb_arrows

boolean

boolean

S,G/-/- defines whether vertical scrollbar has arrows at its end

.vsb_linemotion

integer

integer

S,G/D/C

vertical scroll value for scrolling line by line

.vsb_optional

boolean

boolean

S,G/D/C

vertical scrollbar will be displayed, if necessary

.vsb_pagemotion

integer

integer

S,G/D/C

vertical scroll value for scrolling page by page

.vsb_visible

boolean

boolean

S,G/D/C

visibility of vertical scrollbar

.vwidth

integer

integer

S,G/D/C

internal (virtual) width of object

.width

integer

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

definition type of x-coordinates

.xleft

integer

integer

S,G/D/C

x-coordinate, distance from left

.xorigin

integer

integer

S,G/D/C

shift of the origin along the x-axis in objects with scrollbars

.xraster

integer

integer

S,G/D/C

units in x-direction

.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

y-coordinate, distance from bottom

.yorigin

integer

integer

S,G/D/C

shift of the origin along the y-axis in objects with scrollbars

.yraster

integer

integer

S,G/D/C

units in y-direction

.ytop

integer

integer

S,G/D/C

y-coordinate, distance from top

13.2 Specific Attributes

Standard Attributes

The attribute .font defines the font to be used by objects contained in the groupbox.

Geometry Attributes

The attributes .vwidth and .vheight define the internal object size.

The attributes .xorigin and .yorigin define the origin shift. If these values are set to 0, the origin will be located in the top left corner of the groupbox. If the values are not 0, they specify the positions of the scrollbar sliders.

The grid attributes .xraster, .yraster and .reffont define the unit which is used for the size and position of the objects in the groupbox.

Layout Attributes

.bordercolor defines the color of the groupbox border.

Scrollbar Attributes

The scrollbar attributes .hsb_... and .vsb_... define whether the groupbox is to be provided with scrollbars.

The groupbox can have the following scrollbar attributes:

Operation mode of scrollbars in windows and groupboxes:

The visibility of scrollbars is influenced by the attributes

and

The following rules are valid:

If no scrollbars are set, the virtual size will be ignored.

If the scrollbars are visible,

Note

.hsb/vsb_optional is ignored by the Motif version, i.e. .hsb/vsb_optional implicitly will be always set to true.

To query or to change the scrollbar slider position, the attributes .xorigin and .yorigin have to be used. These attributes specify the shift of the object origin.

The attributes .pagemotion and .linemotion define the shift (in pixels) of object contents during the scrollbar action. Value 0 means that the system default value is to be used; for .pagemotion the scrolling is made page by page.

13.3 Example

The following example describes two groups of radiobuttons in one window.

window Radio_Window

{

  .title "radio window";

  ...

  child groupbox group_1

  {

    child radiobutton First

    { ...

    }

    child radiobutton Second

    { ...

    }

    child radiobutton Third

    { ...

    }

  }

  child groupbox group_2

  {

    child radiobutton Four

    { ...

    }

    child radiobutton Five

    { ...

    }

    child radiobutton Six

    { ...

    }

  }

}

Figure 13-15: Groupbox