30 radiobutton

The radiobutton is a type of button that can be used to select an item out of a group of options (either/or). Only one radiobutton can be selected. If another one is selected, the state belonging to the previously selected radiobutton will be deleted.

By selecting a radiobutton, all radiobuttons on the same hierarchical level are deselected. If more than one radiobutton is to be selected at the same time in one window, their direct parents have to be different. This can be achieved by using groupboxes in which these groups of radiobuttons are located.

Definition

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

Events

Children

Parent

30.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
.active	boolean	boolean	S,G/D/C	activation state of an object
.bgc	identifier	color	S,G/D/C	background color
.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
.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
.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
.lastrecord	object	record	S,G/-/C	accesses the last record of an object
.layoutbox	object	object	S,G/-/C	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
.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_y	integer	integer	-,G/-/-	real distance from top (in pixel)
.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
.text	string identifier	string text	S,G/D/C	static text of object
.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	definition type of x-coordinates
.xleft	integer	integer	S,G/D/C	x-coordinate, distance from left
.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
.ytop	integer	integer	S,G/D/C	y-coordinate, distance from top

30.2 Specific Attributes

Standard Attributes

The attribute .active defines the on state (.active = true) or the off state of the radiobutton.

Plain Attributes

These attributes define the size and position of the radiobutton. If .height or .width is specified as 0, the DM calculates the size of the radiobutton on the basis of the actual font.

The attribute .options can have the following values:

option_index	Meaning
opt_use_widget	Radiobutton is displayed as widget. (on Motif only)
opt_push_like	Radiobutton is displayed like a pushbutton. (on Microsoft Windows only)

30.3 Notes on the radiobutton under Microsoft Windows

Under Microsoft Windows a radiobutton gets activated when it obtains the focus. If an activated radiobutton gets insensitive, the focus moves to the next radiobutton, activating that one. Therefore it should be avoided to set the activated radiobutton insensitive.
Concerning the background color, please refer to the notes on attribute .bgc in the “Attribute Reference”.

30.4 Example

Two groups of radiobuttons in one window.

window Radiowindow

{

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-35: Radiobuttons