BBjWindow::addRadioButton

Description

Creates a radio button control in the BBjWindow that presents the user with a variety of items that can be selected or deselected.

Syntax

Return Value

Method

BBjRadioButton

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

BBjRadioButton

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

BBjRadioButton

addRadioButton(int ID, string title)

BBjRadioButton

addRadioButton(int ID, string title, string flags)

BBjRadioButton

addRadioButton(string title)

BBjRadioButton

addRadioButton(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.

flags

Control flags, as follows:

Flag  Description
$0001$ Sets 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$ Sets 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 BBjRadioButton object.

Remarks

The set of radio buttons in a radio group are mutually exclusive. Thus, only one button from the group may be selected at any given time. Radio buttons are also usually set to be in a keyboard navigation group.

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're all initialized to 0. This is typically for use with DWC windows that dynamically arrange their contents (window creation flag $00100000$).

Example

rem ' BBjRadioButton

sysgui = unt
open (sysgui)"X0"
sysgui! = bbjapi().getSysGui()
window! = sysgui!.addWindow(25,25,200,200,"BBjRadioButton",$00090003$)
window!.setCallback(window!.ON_CLOSE,"eoj")
rb1! = window!.addRadioButton(101,25,25,150,25,"RadioButton1",$0020$)
rb1!.setCallback(rb1!.ON_CHECK_ON,"event")
rb1!.setCallback(rb1!.ON_CHECK_OFF,"event")
rb2! = window!.addRadioButton(102,25,50,150,25,"RadioButton2",$0020$)
rb2!.setCallback(rb2!.ON_CHECK_ON,"event")
rb2!.setCallback(rb2!.ON_CHECK_OFF,"event")
rg1! = bbjapi().makeVector()
rg1!.add(rb1!)
rg1!.add(rb2!)
window!.addRadioGroup(rg1!)
rb3! = window!.addRadioButton(201,25,100,150,25,"RadioButton3",$0020$)
rb3!.setCallback(rb3!.ON_CHECK_ON,"event")
rb3!.setCallback(rb3!.ON_CHECK_OFF,"event")
rb4! = window!.addRadioButton(202,25,125,150,25,"RadioButton4",$0020$)
rb4!.setCallback(rb4!.ON_CHECK_ON,"event")
rb4!.setCallback(rb4!.ON_CHECK_OFF,"event")
rg2! = bbjapi().makeVector()
rg2!.add(rb3!)
rg2!.add(rb4!)
window!.addRadioGroup(rg2!)
process_events

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

eoj:
release

See Also

BBjAPI

BBjSysGui

BBjControl

'RADIOBUTTON' Mnemonic

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