BBjWindow::addGroupBox

Description

Creates a group box in the BBjWindow.

Syntax

Return Value

Method

BBjGroupBox

addGroupBox(int ID, number x, number y, number w, number h, string title)

BBjGroupBox

addGroupBox(int ID, number x, number y, number w, number h, string title, string flags)

BBjGroupBox addGroupBox(int ID, string title)
BBjGroupBox addGroupBox(int ID, string title, string flags)
BBjGroupBox addGroupBox(string title)

BBjGroupBox

addGroupBox(string title, string flags)

Parameters

Variable

Description

 

ID

Control ID number. It must be an integer between 1 and 32767 and be unique within a given top-level window.

x

Horizontal position of the upper-left corner of the control in current units.

y

Vertical position of the upper-left corner of the control in current units.

width

Width of the control in current units.

height

Height of the control in current units.

title

Title of the control. Including the '&' before a character in the title causes it to be an accelerator.

flags

Control flags, as follows:

Flag Description
$0001$ Sets the control to be initially disabled.
$0010$ Sets the control to be initially invisible.
$0800$ Draws a recessed client edge around the control.
$1000$ Draws a raised edge around the control.

Return Value

Returns the created BBjGroupBox object.

Remarks

A group box control is a box with a light gray border surrounding items to visually combine for the user.

If the ID parameter is not specified, a control ID is assigned dynamically using getAvailableControlID().

If the x, y, width, and height parameters are not specified, they are all initialized to 0. This is typically for use with DWC windows that dynamically arrange their contents (window creation flag $00100000$).

For additional information, see Group Box Controls.

Example

rem 'Add a group box control to a window

rem 'Obtain the instance of the BBjAPI object
let myAPI!=BBjAPI()

rem 'Open the SysGui device
SYSGUI=UNT
OPEN (SYSGUI) "X0"

rem 'Obtain the instance of the BBjSysGui object
let mySysGui!=myAPI!.getSysGui()

rem 'Set addWindow param values
X=10
Y=10
WIDTH=200
HEIGHT=200
TITLE$="BBj Window"

rem 'Set the current context
mySysGui!.setContext(0)

rem 'Create a window
myWindow! = mySysGui!.addWindow(X,Y,WIDTH,HEIGHT,TITLE$)

rem 'Add a group box control on the window
myGroupBox! = myWindow!.addGroupBox(101,10,30,150,80,"Group Box")

rem 'Register the CALLBACK routines
CALLBACK(ON_CLOSE,APP_CLOSE,mySysGui!.getContext())

rem 'Process Events
process_events

rem 'Callback routine called when the user closes the application window
APP_CLOSE:
release

See Also

BBjAPI

BBjSysGui

BBjControl

BBjWindow

`GROUPBOX' Mnemonic

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.