]>
Commit | Line | Data |
---|---|---|
3972fb49 JS |
1 | \section{\class{wxCheckListBox}}\label{wxchecklistbox} |
2 | ||
3 | A checklistbox is like a listbox, but allows items to be checked or unchecked. | |
4 | ||
12a44087 RR |
5 | This class is currently implemented under Windows and GTK. When using this |
6 | class under Windows wxWindows must be compiled with USE\_OWNER\_DRAWN set to 1. | |
3972fb49 JS |
7 | |
8 | Only the new functions for this class are documented; see also \helpref{wxListBox}{wxlistbox}. | |
9 | ||
10 | \wxheading{Derived from} | |
11 | ||
12 | \helpref{wxListBox}{wxlistbox}\\ | |
13 | \helpref{wxControl}{wxcontrol}\\ | |
14 | \helpref{wxWindow}{wxwindow}\\ | |
15 | \helpref{wxEvtHandler}{wxevthandler}\\ | |
16 | \helpref{wxObject}{wxobject} | |
17 | ||
954b8ae6 JS |
18 | \wxheading{Include files} |
19 | ||
20 | <wx/checklst.h> | |
21 | ||
3972fb49 JS |
22 | \wxheading{Window styles} |
23 | ||
24 | See \helpref{wxListBox}{wxlistbox}. | |
25 | ||
26 | \wxheading{Event handling} | |
27 | ||
28 | See \helpref{wxListBox}{wxlistbox}. | |
29 | ||
30 | \wxheading{See also} | |
31 | ||
32 | \helpref{wxListBox}{wxlistbox}, \helpref{wxChoice}{wxchoice}, \helpref{wxComboBox}{wxcombobox}, \helpref{wxListCtrl}{wxlistctrl}, | |
33 | \rtfsp\helpref{wxCommandEvent}{wxcommandevent} | |
34 | ||
35 | \latexignore{\rtfignore{\wxheading{Members}}} | |
36 | ||
37 | \membersection{wxCheckListBox::wxCheckListBox}\label{wxchecklistboxconstr} | |
38 | ||
39 | \func{}{wxCheckListBox}{\void} | |
40 | ||
41 | Default constructor. | |
42 | ||
43 | \func{}{wxCheckListBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp | |
44 | \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp | |
45 | \param{int}{ n}, \param{const wxString }{choices[] = NULL},\rtfsp | |
46 | \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}} | |
47 | ||
48 | Constructor, creating and showing a list box. | |
49 | ||
50 | \wxheading{Parameters} | |
51 | ||
52 | \docparam{parent}{Parent window. Must not be NULL.} | |
53 | ||
54 | \docparam{id}{Window identifier. A value of -1 indicates a default value.} | |
55 | ||
56 | \docparam{pos}{Window position.} | |
57 | ||
58 | \docparam{size}{Window size. If the default size (-1, -1) is specified then the window is sized | |
59 | appropriately.} | |
60 | ||
61 | \docparam{n}{Number of strings with which to initialise the control.} | |
62 | ||
63 | \docparam{choices}{An array of strings with which to initialise the control.} | |
64 | ||
65 | \docparam{style}{Window style. See \helpref{wxCheckListBox}{wxchecklistbox}.} | |
66 | ||
67 | \docparam{validator}{Window validator.} | |
68 | ||
69 | \docparam{name}{Window name.} | |
70 | ||
71 | \membersection{wxCheckListBox::\destruct{wxCheckListBox}} | |
72 | ||
73 | \func{void}{\destruct{wxCheckListBox}}{\void} | |
74 | ||
75 | Destructor, destroying the list box. | |
76 | ||
77 | \membersection{wxCheckListBox::Check}\label{wxchecklistboxcheck} | |
78 | ||
79 | \func{void}{Check}{\param{int }{item}, \param{bool}{ check = TRUE}} | |
80 | ||
81 | Checks the given item. | |
82 | ||
83 | \wxheading{Parameters} | |
84 | ||
85 | \docparam{item}{Index of item to check.} | |
86 | ||
87 | \docparam{check}{TRUE if the item is to be checked, FALSE otherwise.} | |
88 | ||
89 | \membersection{wxCheckListBox::IsChecked}\label{wxchecklistboxischecked} | |
90 | ||
91 | \constfunc{bool}{IsChecked}{\param{int}{ item}} | |
92 | ||
93 | Returns TRUE if the given item is checked, FALSE otherwise. | |
94 | ||
95 | \wxheading{Parameters} | |
96 | ||
97 | \docparam{item}{Index of item whose check status is to be returned.} | |
98 | ||
99 |