focal (3) wxCheckBox.3erl.gz

NAME

       wxCheckBox - See external documentation: wxCheckBox.

DESCRIPTION

       See external documentation: wxCheckBox.

       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.

       new(Parent, Id, Label) -> wxCheckBox()

              Types:

                 Parent = wxWindow:wxWindow()
                 Id = integer()
                 Label = unicode:chardata()

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

       new(Parent, Id, Label, Options::[Option]) -> wxCheckBox()

              Types:

                 Parent = wxWindow:wxWindow()
                 Id = integer()
                 Label = unicode:chardata()
                 Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}}  |  {style,
                 integer()} | {validator, wx:wx_object()}

              See external documentation.

       create(This, Parent, Id, Label) -> boolean()

              Types:

                 This = wxCheckBox()
                 Parent = wxWindow:wxWindow()
                 Id = integer()
                 Label = unicode:chardata()

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

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

              Types:

                 This = wxCheckBox()
                 Parent = wxWindow:wxWindow()
                 Id = integer()
                 Label = unicode:chardata()
                 Option  =  {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style,
                 integer()} | {validator, wx:wx_object()}

              See external documentation.

       getValue(This) -> boolean()

              Types:

                 This = wxCheckBox()

              See external documentation.

       get3StateValue(This) -> wx:wx_enum()

              Types:

                 This = wxCheckBox()

              See external documentation.
              Res = ?wxCHK_UNCHECKED | ?wxCHK_CHECKED | ?wxCHK_UNDETERMINED

       is3rdStateAllowedForUser(This) -> boolean()

              Types:

                 This = wxCheckBox()

              See external documentation.

       is3State(This) -> boolean()

              Types:

                 This = wxCheckBox()

              See external documentation.

       isChecked(This) -> boolean()

              Types:

                 This = wxCheckBox()

              See external documentation.

       setValue(This, State) -> ok

              Types:

                 This = wxCheckBox()
                 State = boolean()

              See external documentation.

       set3StateValue(This, State) -> ok

              Types:

                 This = wxCheckBox()
                 State = wx:wx_enum()

              See external documentation.
              State = ?wxCHK_UNCHECKED | ?wxCHK_CHECKED | ?wxCHK_UNDETERMINED

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

              Destroys this object, do not use object again

AUTHORS

       <>

                                                     wx 1.9                                     wxCheckBox(3erl)