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