wxRadioBox

Module

wxRadioBox

Module Summary

Functions for wxRadioBox class

Description

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.

Styles

This class supports the following styles:

See: Overview events, wxRadioButton, wxCheckBox

This class is derived (and can use functions) from: wxControl wxWindow wxEvtHandler

wxWidgets docs: wxRadioBox

Events

Event types emitted from this class: command_radiobox_selected

Data Types

wxRadioBox() = wx:wx_object()

Exports

new(Parent, Id, Label, Pos, Size, Choices) -> wxRadioBox()

Types

Parent = wxWindow:wxWindow()

Id = integer()

Label = unicode:chardata()

Pos = {X :: integer(), Y :: integer()}

Size = {W :: integer(), H :: integer()}

Choices = [unicode:chardata()]

new(Parent, Id, Label, Pos, Size, Choices, Options :: [Option]) ->
wxRadioBox()

Types

Parent = wxWindow:wxWindow()

Id = integer()

Label = unicode:chardata()

Pos = {X :: integer(), Y :: integer()}

Size = {W :: integer(), H :: integer()}

Choices = [unicode:chardata()]

Option =
    {majorDim, integer()} |
    {style, integer()} |
    {val, wx:wx_object()}

Constructor, creating and showing a radiobox.

See: create/8, wxValidator (not implemented in wx)

destroy(This :: wxRadioBox()) -> ok

Destructor, destroying the radiobox item.

create(This, Parent, Id, Label, Pos, Size, Choices) -> boolean()

Types

This = wxRadioBox()

Parent = wxWindow:wxWindow()

Id = integer()

Label = unicode:chardata()

Pos = {X :: integer(), Y :: integer()}

Size = {W :: integer(), H :: integer()}

Choices = [unicode:chardata()]

create(This, Parent, Id, Label, Pos, Size, Choices,
Options :: [Option]) ->
boolean()

Types

This = wxRadioBox()

Parent = wxWindow:wxWindow()

Id = integer()

Label = unicode:chardata()

Pos = {X :: integer(), Y :: integer()}

Size = {W :: integer(), H :: integer()}

Choices = [unicode:chardata()]

Option =
    {majorDim, integer()} |
    {style, integer()} |
    {val, wx:wx_object()}

Creates the radiobox for two-step construction.

See new/7 for further details.

enable(This) -> boolean()

Types

This = wxRadioBox()

enable(This, N) -> boolean()

enable(This, N :: [Option]) -> boolean()

Types

This = wxRadioBox()

Option = {enable, boolean()}

Enables or disables the radiobox.

See: wxWindow:enable/2

enable(This, N, Options :: [Option]) -> boolean()

Types

This = wxRadioBox()

N = integer()

Option = {enable, boolean()}

Enables or disables an individual button in the radiobox.

See: wxWindow:enable/2

getSelection(This) -> integer()

Types

This = wxRadioBox()

Returns the index of the selected item or wxNOT_FOUND if no item is selected.

Return: The position of the current selection.

Remark: This method can be used with single selection list boxes only, you should use wxListBox:getSelections/1 for the list boxes with wxLB_MULTIPLE style.

See: setSelection/2, wxControlWithItems:getStringSelection/1

getString(This, N) -> unicode:charlist()