BBjWindow::addCheckBox

Description

Creates a check box control in the BBjWindow.

Syntax

Return Value

Method

BBjCheckBox

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

BBjCheckBox

addCheckBox(int ID, number x, number y, number w, number h, string title, string flags)
BBjCheckBox addCheckBox(int ID, string title)
BBjCheckBox addCheckBox(int ID, string title, string flags)
BBjCheckBox addCheckBox(string title)
BBjCheckBox addCheckBox(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$ Causes the control to be initially disabled.
$0002$ Places title text to the left of the control.
$0004$ Sets the control to be initially checked.
$0010$ Causes the control to be initially invisible.
$0020$ Designates the control to be part of a keyboard navigation group.
$0800$ Draws a recessed client edge around the control.
$1000$ Draws a raised edge around the control.

Return Value

Returns the created BBjCheckBox object.

Remarks

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

Example

rem ' BBjCheckBox

sysgui = unt
open (sysgui)"X0"
sysgui! = bbjapi().getSysGui()
window! = sysgui!.addWindow(25,25,200,200,"BBjCheckBox",$00090003$)
window!.setCallback(window!.ON_CLOSE,"eoj")
cb1! = window!.addCheckBox(101,25,25,150,25,"CheckBox1",$0000$)
cb1!.setCallback(cb1!.ON_CHECK_ON,"event")
cb1!.setCallback(cb1!.ON_CHECK_OFF,"event")
cb2! = window!.addCheckBox(102,25,50,150,25,"CheckBox2",$0000$)
cb2!.setCallback(cb2!.ON_CHECK_ON,"event")
cb2!.setCallback(cb2!.ON_CHECK_OFF,"event")
cb3! = window!.addCheckBox(201,25,100,150,25,"CheckBox3",$0020$)
cb3!.setCallback(cb3!.ON_CHECK_ON,"event")
cb3!.setCallback(cb3!.ON_CHECK_OFF,"event")
cb4! = window!.addCheckBox(202,25,125,150,25,"CheckBox4",$0024$)
cb4!.setCallback(cb4!.ON_CHECK_ON,"event")
cb4!.setCallback(cb4!.ON_CHECK_OFF,"event")
process_events

event:
    event! = sysgui!.getLastEvent()
    i = msgbox(event!.getCheckBox().getText(),0,event!.getEventName())
return

eoj:
release

See Also

BBjAPI

BBjSysGui

BBjControl

BBjWindow

`CHECKBOX' Mnemonic

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