wxJavaScript

back to gui 

wxRadioBox

^{generated from ../src/mod_gui/control/radiobox.cpp}

A radio box item is used to select one of number of mutually exclusive choices. It is displayed as a vertical column or horizontal row of labelled buttons.

Constants

Styles

Name	Description
SPECIFY_ROWS	The major dimension parameter refers to the maximum number of rows.
SPECIFY_COLS	The major dimension parameter refers to the maximum number of columns.

Constructor

wxRadioBox

wxRadioBox()
 

wxRadioBox(Parent, 
           Id, 
           Title, 
           Position = wxDefaultPosition, 
           Size = wxDefaultSize, 
           Items = null, 
           MaximumDimension = 0, 
           Style = SPECIFY_COLS, 
           Validator = null)
 

Name	Type	Default	Description
Parent	wxWindow		The parent of wxRadioBox.
Id	Integer		A window identifier. Use -1 when you don't need it.
Title	String		The title of the radiobox.
Position	wxPoint	wxDefaultPosition	The position of the RadioBox control on the given parent.
Size	wxSize	wxDefaultSize	The size of the RadioBox control.
Items	Array	null	An array of Strings to initialize the control.
MaximumDimension	Integer	0	Specifies the maximum number of rows (if style contains SPECIFY_ROWS) or columns (if style contains SPECIFY_COLS) for a two-dimensional radiobox.
Style	Integer	SPECIFY_COLS	The wxRadioBox style.
Validator	wxValidator	null

Constructs a new wxRadioBox object.

Properties

Name	Type	Description
count	Integer	Get the number of items
item	Array	Get an array of with wxRadioBoxItem items.
selection	Integer	Get/Set the selected button. (zero-indexed)
stringSelection	String	Get/Set the selected string.

Methods

create

create(Parent, 
       Id, 
       Title, 
       Position = wxDefaultPosition, 
       Size = wxDefaultSize, 
       Items = null, 
       MaximumDimension = 0, 
       Style = SPECIFY_COLS, 
       Validator = null) : Boolean
 

Name	Type	Default	Description
Parent	wxWindow		The parent of wxRadioBox.
Id	Integer		A window identifier. Use -1 when you don't need it.
Title	String		The title of the radiobox.
Position	wxPoint	wxDefaultPosition	The position of the RadioBox control on the given parent.
Size	wxSize	wxDefaultSize	The size of the RadioBox control.
Items	Array	null	An array of Strings to initialize the control.
MaximumDimension	Integer	0	Specifies the maximum number of rows (if style contains SPECIFY_ROWS) or columns (if style contains SPECIFY_COLS) for a two-dimensional radiobox.
Style	Integer	SPECIFY_COLS	The wxRadioBox style.
Validator	wxValidator	null

Constructs a new wxRadioBox object.

enable

enable(Switch)
 

Name	Type	Default	Description
Switch	Boolean

enable(Index, 
       Switch)
 

Name	Type	Default	Description
Index	Integer		The zero-based index of a button
Switch	Boolean

Enables/Disables the button at the given index. See wxRadioBoxItem enable.

findString

findString(Str) : Integer
 

Name	Type	Default	Description
Str	String

Finds a button matching the given string, returning the position if found, or -1 if not found.

setString

setString(Index, 
          Label)
 

Name	Type	Default	Description
Index	Integer		The zero-based index of a button
Label	String		Sets the label of the button.

show

show(Switch)
 

Name	Type	Default	Description
Switch	Boolean

show(Index, 
     Switch)
 

Name	Type	Default	Description
Index	Integer		The zero-based index of a button
Switch	Boolean

Shows/Hides the button at the given index. See wxRadioBoxItem enable.

Events

onRadioBox

Called when a radio button is clicked. The type of the argument that your handler receives is wxCommandEvent.