查看源码 wxCheckBox (wx v2.4.3)

复选框是一个带有标签的框,默认情况下要么是选中状态(显示复选标记),要么是未选中状态(不显示复选标记)。

可选地(当设置了 wxCHK_3STATE 样式标志时),它可以有第三种状态,称为混合状态或未确定状态。通常,这用作“不适用”状态。

样式

此类支持以下样式

  • wxCHK_2STATE:创建一个 2 状态的复选框。这是默认值。

  • wxCHK_3STATE:创建一个 3 状态的复选框。在 wxGTK1 中未实现。

  • wxCHK_ALLOW_3RD_STATE_FOR_USER:默认情况下,用户无法将 3 状态的复选框设置为第三种状态。只能通过代码设置。使用此标志允许用户通过单击将复选框设置为第三种状态。

  • wxALIGN_RIGHT:使文本显示在复选框的左侧。

参见

此类派生自以下类,可以使用这些类的函数

wxWidgets 文档: wxCheckBox

事件

此类发出的事件类型

摘要

函数

创建用于两步构造的复选框。

销毁对象

获取 3 状态复选框的状态。

获取 2 状态复选框的状态。

返回用户是否可以将复选框设置为第三种状态。

返回复选框是否为 3 状态复选框。

这只是 getValue/1 的一个可能更具可读性的同义词:与后者一样,如果复选框被选中,则返回 true,否则返回 false。

默认构造函数。

构造函数,创建并显示一个复选框。

将复选框设置为给定的状态。

将复选框设置为给定的状态。

类型

-type wxCheckBox() :: wx:wx_object().

函数

链接到此函数

create(This, Parent, Id, Label)

查看源码
-spec create(This, Parent, Id, Label) -> boolean()
                when
                    This :: wxCheckBox(),
                    Parent :: wxWindow:wxWindow(),
                    Id :: integer(),
                    Label :: unicode:chardata().

等同于 create(This, Parent, Id, Label, [])

-spec create(This, Parent, Id, Label, [Option]) -> boolean()
                when
                    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()}.

创建用于两步构造的复选框。

有关详细信息,请参见 new/4

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

销毁对象

链接到此函数

get3StateValue(This)

查看源码
-spec get3StateValue(This) -> wx:wx_enum() when This :: wxCheckBox().

获取 3 状态复选框的状态。

当函数与 2 状态复选框一起使用时断言。

-spec getValue(This) -> boolean() when This :: wxCheckBox().

获取 2 状态复选框的状态。

返回:如果选中则返回 true,否则返回 false。

链接到此函数

is3rdStateAllowedForUser(This)

查看源码
-spec is3rdStateAllowedForUser(This) -> boolean() when This :: wxCheckBox().

返回用户是否可以将复选框设置为第三种状态。

返回:如果用户可以设置此复选框的第三种状态,则返回 true;如果只能以编程方式设置或如果是 2 状态复选框,则返回 false。

-spec is3State(This) -> boolean() when This :: wxCheckBox().

返回复选框是否为 3 状态复选框。

返回:如果此复选框是 3 状态复选框,则返回 true;如果它是 2 状态复选框,则返回 false。

-spec isChecked(This) -> boolean() when This :: wxCheckBox().

这只是 getValue/1 的一个可能更具可读性的同义词:与后者一样,如果复选框被选中,则返回 true,否则返回 false。

-spec new() -> wxCheckBox().

默认构造函数。

参见:create/5

链接到此函数

new(Parent, Id, Label)

查看源码
-spec new(Parent, Id, Label) -> wxCheckBox()
             when Parent :: wxWindow:wxWindow(), Id :: integer(), Label :: unicode:chardata().

等同于 new(Parent, Id, Label, [])

-spec new(Parent, Id, Label, [Option]) -> wxCheckBox()
             when
                 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()}.

构造函数,创建并显示一个复选框。

参见:create/5

链接到此函数

set3StateValue(This, State)

查看源码
-spec set3StateValue(This, State) -> ok when This :: wxCheckBox(), State :: wx:wx_enum().

将复选框设置为给定的状态。

这不会导致发出 wxEVT_CHECKBOX 事件。

当复选框是 2 状态复选框并将状态设置为 wxCHK_UNDETERMINED 时断言。

链接到此函数

setValue(This, State)

查看源码
-spec setValue(This, State) -> ok when This :: wxCheckBox(), State :: boolean().

将复选框设置为给定的状态。

这不会导致发出 wxEVT_CHECKBOX 事件。