]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: checklst.h | |
3 | // Purpose: interface of wxCheckListBox | |
4 | // Author: wxWidgets team | |
5 | // RCS-ID: $Id$ | |
6 | // Licence: wxWindows license | |
7 | ///////////////////////////////////////////////////////////////////////////// | |
8 | ||
9 | /** | |
10 | @class wxCheckListBox | |
11 | ||
12 | A wxCheckListBox is like a wxListBox, but allows items to be checked or | |
13 | unchecked. | |
14 | ||
15 | When using this class under Windows wxWidgets must be compiled with | |
16 | wxUSE_OWNER_DRAWN set to 1. | |
17 | ||
18 | @beginEventEmissionTable{wxCommandEvent} | |
19 | @event{EVT_CHECKLISTBOX(id, func)} | |
20 | Process a wxEVT_COMMAND_CHECKLISTBOX_TOGGLED event, when an item in | |
21 | the check list box is checked or unchecked. wxCommandEvent::GetInt() | |
22 | will contain the index of the item that was checked or unchecked. | |
23 | wxCommandEvent::IsChecked() is not valid! Use wxCheckListBox::IsChecked() | |
24 | instead. | |
25 | @endEventTable | |
26 | ||
27 | @library{wxcore} | |
28 | @category{ctrl} | |
29 | @appearance{checklistbox.png} | |
30 | ||
31 | @see wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent | |
32 | */ | |
33 | class wxCheckListBox : public wxListBox | |
34 | { | |
35 | public: | |
36 | /** | |
37 | Default constructor. | |
38 | */ | |
39 | wxCheckListBox(); | |
40 | ||
41 | //@{ | |
42 | /** | |
43 | Constructor, creating and showing a list box. | |
44 | ||
45 | @param parent | |
46 | Parent window. Must not be @NULL. | |
47 | @param id | |
48 | Window identifier. The value wxID_ANY indicates a default value. | |
49 | @param pos | |
50 | Window position. | |
51 | If ::wxDefaultPosition is specified then a default position is chosen. | |
52 | @param size | |
53 | Window size. | |
54 | If ::wxDefaultSize is specified then the window is sized appropriately. | |
55 | @param n | |
56 | Number of strings with which to initialise the control. | |
57 | @param choices | |
58 | An array of strings with which to initialise the control. | |
59 | @param style | |
60 | Window style. See wxCheckListBox. | |
61 | @param validator | |
62 | Window validator. | |
63 | @param name | |
64 | Window name. | |
65 | */ | |
66 | wxCheckListBox(wxWindow* parent, wxWindowID id, | |
67 | const wxPoint& pos = wxDefaultPosition, | |
68 | const wxSize& size = wxDefaultSize, | |
69 | int n = 0, | |
70 | const wxString choices[] = NULL, | |
71 | long style = 0, | |
72 | const wxValidator& validator = wxDefaultValidator, | |
73 | const wxString& name = "listBox"); | |
74 | /** | |
75 | Constructor, creating and showing a list box. | |
76 | ||
77 | @param parent | |
78 | Parent window. Must not be @NULL. | |
79 | @param id | |
80 | Window identifier. The value wxID_ANY indicates a default value. | |
81 | @param pos | |
82 | Window position. | |
83 | @param size | |
84 | Window size. If wxDefaultSize is specified then the window is sized | |
85 | appropriately. | |
86 | @param choices | |
87 | An array of strings with which to initialise the control. | |
88 | @param style | |
89 | Window style. See wxCheckListBox. | |
90 | @param validator | |
91 | Window validator. | |
92 | @param name | |
93 | Window name. | |
94 | */ | |
95 | wxCheckListBox(wxWindow* parent, wxWindowID id, | |
96 | const wxPoint& pos, | |
97 | const wxSize& size, | |
98 | const wxArrayString& choices, | |
99 | long style = 0, | |
100 | const wxValidator& validator = wxDefaultValidator, | |
101 | const wxString& name = "listBox"); | |
102 | //@} | |
103 | ||
104 | /** | |
105 | Destructor, destroying the list box. | |
106 | */ | |
107 | virtual ~wxCheckListBox(); | |
108 | ||
109 | /** | |
110 | Checks the given item. Note that calling this method does not result in | |
111 | a wxEVT_COMMAND_CHECKLISTBOX_TOGGLE event being emitted. | |
112 | ||
113 | @param item | |
114 | Index of item to check. | |
115 | @param check | |
116 | @true if the item is to be checked, @false otherwise. | |
117 | */ | |
118 | void Check(unsigned int item, bool check = true); | |
119 | ||
120 | /** | |
121 | Returns @true if the given item is checked, @false otherwise. | |
122 | ||
123 | @param item | |
124 | Index of item whose check status is to be returned. | |
125 | */ | |
126 | bool IsChecked(unsigned int item) const; | |
127 | }; | |
128 |