1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/////////////////////////////////////////////////////////////////////////////
// Name: _checkbox.i
// Purpose: SWIG interface defs for wxCheckBox
//
// Author: Robin Dunn
//
// Created: 10-June-1998
// RCS-ID: $Id: _checkbox.i,v 1.11 2004/06/02 20:52:59 RD Exp $
// Copyright: (c) 2003 by Total Control Software
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
// Not a %module
//---------------------------------------------------------------------------
%newgroup;
MAKE_CONST_WXSTRING(CheckBoxNameStr);
enum {
// Determine whether to use a 3-state or 2-state
// checkbox. 3-state enables to differentiate
// between 'unchecked', 'checked' and 'undetermined'.
wxCHK_2STATE,
wxCHK_3STATE,
// If this style is set the user can set the checkbox to the
// undetermined state. If not set the undetermined set can only
// be set programmatically.
// This style can only be used with 3 state checkboxes.
wxCHK_ALLOW_3RD_STATE_FOR_USER,
};
enum wxCheckBoxState
{
wxCHK_UNCHECKED,
wxCHK_CHECKED,
wxCHK_UNDETERMINED /* 3-state checkbox only */
};
//---------------------------------------------------------------------------
DocStr(wxCheckBox,
"A checkbox is a labelled box which by default is either on (the
checkmark is visible) or off (no checkmark). Optionally (When the
wx.CHK_3STATE style flag is set) it can have a third state, called the
mixed or undetermined state. Often this is used as a \"Does Not
Apply\" state.", "
Window Styles
-------------
================================= ===============================
wx.CHK_2STATE Create a 2-state checkbox.
This is the default.
wx.CHK_3STATE Create a 3-state checkbox.
wx.CHK_ALLOW_3RD_STATE_FOR_USER By default a user can't set a
3-state checkbox to the
third state. It can only be
done from code. Using this
flags allows the user to set
the checkbox to the third
state by clicking.
wx.ALIGN_RIGHT Makes the
text appear on the left of
the checkbox.
================================= ===============================
Events
------
=============================== ===============================
EVT_CHECKBOX Sent when checkbox is clicked.
=============================== ===============================
");
MustHaveApp(wxCheckBox);
class wxCheckBox : public wxControl
{
public:
%pythonAppend wxCheckBox "self._setOORInfo(self)"
%pythonAppend wxCheckBox() ""
DocCtorStr(
wxCheckBox(wxWindow* parent, wxWindowID id=-1,
const wxString& label = wxPyEmptyString,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxPyCheckBoxNameStr),
"Creates and shows a CheckBox control", "");
DocCtorStrName(
wxCheckBox(),
"Precreate a CheckBox for 2-phase creation.", "",
PreCheckBox);
DocDeclStr(
bool, Create(wxWindow* parent, wxWindowID id=-1,
const wxString& label = wxPyEmptyString,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxPyCheckBoxNameStr),
"Actually create the GUI CheckBox for 2-phase creation.", "");
DocDeclStr(
bool, GetValue(),
"Gets the state of a 2-state CheckBox. Returns True if it is checked,
False otherwise.", "");
DocDeclStr(
bool, IsChecked(),
"Similar to GetValue, but raises an exception if it is not a 2-state
CheckBox.", "");
DocDeclStr(
void, SetValue(const bool state),
"Set the state of a 2-state CheckBox. Pass True for checked, False for
unchecked.", "");
DocDeclStr(
wxCheckBoxState, Get3StateValue() const,
"Returns wx.CHK_UNCHECKED when the CheckBox is unchecked,
wx.CHK_CHECKED when it is checked and wx.CHK_UNDETERMINED when it's in
the undetermined state. Raises an exceptiion when the function is
used with a 2-state CheckBox.", "");
DocDeclStr(
void, Set3StateValue(wxCheckBoxState state),
"Sets the CheckBox to the given state. The state parameter can be one
of the following: wx.CHK_UNCHECKED (Check is off), wx.CHK_CHECKED (the
Check is on) or wx.CHK_UNDETERMINED (Check is mixed). Raises an
exception when the CheckBox is a 2-state checkbox and setting the
state to wx.CHK_UNDETERMINED.", "");
DocDeclStr(
bool, Is3State() const,
"Returns whether or not the CheckBox is a 3-state CheckBox.", "");
DocDeclStr(
bool, Is3rdStateAllowedForUser() const,
"Returns whether or not the user can set the CheckBox to the third
state.", "");
static wxVisualAttributes
GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
};
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
|
