wxCheckBox(3)

MODULE
wxCheckBox - See external documentation: wxCheckBox.

DESCRIPTION

See external documentation: wxCheckBox <http://www.wxwidgets.org/manuals/stable/wx_wxcheckbox.html>.

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

DATA TYPES

    wxCheckBox():

        An object reference, The representation is internal and can be changed without notice. It can't be used for comparsion stored on disc or distributed for use on other nodes.

EXPORTS

new() -> wxCheckBox()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcheckbox.html#wxcheckboxwxcheckbox>.

new(Parent::wxWindow() (see module wxWindow), Id::integer(), Label::string()) -> wxCheckBox()

    Equivalent to new(Parent, Id, Label, []).

new(Parent::wxWindow() (see module wxWindow), Id::integer(), Label::string(), Options::[Option]) -> wxCheckBox()

    Types
        Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx() (see module wx)}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcheckbox.html#wxcheckboxwxcheckbox>.

create(This::wxCheckBox(), Parent::wxWindow() (see module wxWindow), Id::integer(), Label::string()) -> bool()

    Equivalent to create(This, Parent, Id, Label, []).

create(This::wxCheckBox(), Parent::wxWindow() (see module wxWindow), Id::integer(), Label::string(), Options::[Option]) -> bool()

    Types
        Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()} | {validator, wx() (see module wx)}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcheckbox.html#wxcheckboxcreate>.

getValue(This::wxCheckBox()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcheckbox.html#wxcheckboxgetvalue>.

get3StateValue(This::wxCheckBox()) -> WxCheckBoxState

    Types
        WxCheckBoxState = integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcheckbox.html#wxcheckboxget3statevalue>.
     WxCheckBoxState is one of ?wxCHK_UNCHECKED | ?wxCHK_CHECKED | ?wxCHK_UNDETERMINED

is3rdStateAllowedForUser(This::wxCheckBox()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcheckbox.html#wxcheckboxis3rdstateallowedforuser>.

is3State(This::wxCheckBox()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcheckbox.html#wxcheckboxis3state>.

isChecked(This::wxCheckBox()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcheckbox.html#wxcheckboxischecked>.

setValue(This::wxCheckBox(), State::bool()) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcheckbox.html#wxcheckboxsetvalue>.

set3StateValue(This::wxCheckBox(), State::WxCheckBoxState) -> ok

    Types
        WxCheckBoxState = integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxcheckbox.html#wxcheckboxset3statevalue>.
     WxCheckBoxState is one of ?wxCHK_UNCHECKED | ?wxCHK_CHECKED | ?wxCHK_UNDETERMINED

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

    Destroys this object, do not use object again