]>
Commit | Line | Data |
---|---|---|
aa61d352 VZ |
1 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
2 | %% Name: checklst.tex | |
3 | %% Purpose: wxCheckListBox documentation | |
4 | %% Author: wxWidgets Team | |
5 | %% Modified by: | |
6 | %% Created: | |
7 | %% RCS-ID: $Id$ | |
8 | %% Copyright: (c) wxWidgets Team | |
9 | %% License: wxWindows license | |
10 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
11 | ||
3972fb49 JS |
12 | \section{\class{wxCheckListBox}}\label{wxchecklistbox} |
13 | ||
14 | A checklistbox is like a listbox, but allows items to be checked or unchecked. | |
15 | ||
f3542025 | 16 | When using this class under Windows wxWidgets must be compiled with USE\_OWNER\_DRAWN set to 1. |
3972fb49 JS |
17 | |
18 | Only the new functions for this class are documented; see also \helpref{wxListBox}{wxlistbox}. | |
19 | ||
03ca23b6 JS |
20 | Please note that wxCheckListBox uses client data in its implementation, |
21 | and therefore this is not available to the application. | |
22 | ||
3972fb49 JS |
23 | \wxheading{Derived from} |
24 | ||
25 | \helpref{wxListBox}{wxlistbox}\\ | |
26 | \helpref{wxControl}{wxcontrol}\\ | |
27 | \helpref{wxWindow}{wxwindow}\\ | |
28 | \helpref{wxEvtHandler}{wxevthandler}\\ | |
29 | \helpref{wxObject}{wxobject} | |
30 | ||
954b8ae6 JS |
31 | \wxheading{Include files} |
32 | ||
33 | <wx/checklst.h> | |
34 | ||
a7af285d VZ |
35 | \wxheading{Library} |
36 | ||
37 | \helpref{wxCore}{librarieslist} | |
38 | ||
3972fb49 JS |
39 | \wxheading{Window styles} |
40 | ||
41 | See \helpref{wxListBox}{wxlistbox}. | |
42 | ||
43 | \wxheading{Event handling} | |
44 | ||
dd3c394a VZ |
45 | \twocolwidtha{7cm} |
46 | \begin{twocollist}\itemsep=0pt | |
3195dca7 | 47 | \twocolitem{{\bf EVT\_CHECKLISTBOX(id, func)}}{Process a wxEVT\_COMMAND\_CHECKLISTBOX\_TOGGLED event, |
dd3c394a VZ |
48 | when an item in the check list box is checked or unchecked.} |
49 | \end{twocollist} | |
3972fb49 JS |
50 | |
51 | \wxheading{See also} | |
52 | ||
53 | \helpref{wxListBox}{wxlistbox}, \helpref{wxChoice}{wxchoice}, \helpref{wxComboBox}{wxcombobox}, \helpref{wxListCtrl}{wxlistctrl}, | |
54 | \rtfsp\helpref{wxCommandEvent}{wxcommandevent} | |
55 | ||
56 | \latexignore{\rtfignore{\wxheading{Members}}} | |
57 | ||
f510b7b2 | 58 | \membersection{wxCheckListBox::wxCheckListBox}\label{wxchecklistboxctor} |
3972fb49 JS |
59 | |
60 | \func{}{wxCheckListBox}{\void} | |
61 | ||
62 | Default constructor. | |
63 | ||
64 | \func{}{wxCheckListBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp | |
65 | \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp | |
66 | \param{int}{ n}, \param{const wxString }{choices[] = NULL},\rtfsp | |
67 | \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}} | |
68 | ||
56b88f12 MB |
69 | \func{}{wxCheckListBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp |
70 | \param{const wxPoint\&}{ pos}, \param{const wxSize\&}{ size},\rtfsp | |
71 | \param{const wxArrayString\& }{choices},\rtfsp | |
72 | \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}} | |
73 | ||
3972fb49 JS |
74 | Constructor, creating and showing a list box. |
75 | ||
76 | \wxheading{Parameters} | |
77 | ||
78 | \docparam{parent}{Parent window. Must not be NULL.} | |
79 | ||
80 | \docparam{id}{Window identifier. A value of -1 indicates a default value.} | |
81 | ||
82 | \docparam{pos}{Window position.} | |
83 | ||
84 | \docparam{size}{Window size. If the default size (-1, -1) is specified then the window is sized | |
85 | appropriately.} | |
86 | ||
87 | \docparam{n}{Number of strings with which to initialise the control.} | |
88 | ||
89 | \docparam{choices}{An array of strings with which to initialise the control.} | |
90 | ||
91 | \docparam{style}{Window style. See \helpref{wxCheckListBox}{wxchecklistbox}.} | |
92 | ||
93 | \docparam{validator}{Window validator.} | |
94 | ||
95 | \docparam{name}{Window name.} | |
96 | ||
c9110876 VS |
97 | \pythonnote{The wxCheckListBox constructor in wxPython reduces the {\tt n} |
98 | and {\tt choices} arguments are to a single argument, which is | |
06d20283 RD |
99 | a list of strings.} |
100 | ||
5873607e VZ |
101 | \perlnote{In wxPerl there is just an array reference in place of {\tt n} |
102 | and {\tt choices}.} | |
103 | ||
f510b7b2 | 104 | \membersection{wxCheckListBox::\destruct{wxCheckListBox}}\label{wxchecklistboxdtor} |
3972fb49 JS |
105 | |
106 | \func{void}{\destruct{wxCheckListBox}}{\void} | |
107 | ||
108 | Destructor, destroying the list box. | |
109 | ||
110 | \membersection{wxCheckListBox::Check}\label{wxchecklistboxcheck} | |
111 | ||
cc81d32f | 112 | \func{void}{Check}{\param{int }{item}, \param{bool}{ check = true}} |
3972fb49 | 113 | |
e2ca995f VZ |
114 | Checks the given item. Note that calling this method doesn't result in |
115 | wxEVT\_COMMAND\_CHECKLISTBOX\_TOGGLE being emitted. | |
3972fb49 JS |
116 | |
117 | \wxheading{Parameters} | |
118 | ||
119 | \docparam{item}{Index of item to check.} | |
120 | ||
cc81d32f | 121 | \docparam{check}{true if the item is to be checked, false otherwise.} |
3972fb49 JS |
122 | |
123 | \membersection{wxCheckListBox::IsChecked}\label{wxchecklistboxischecked} | |
124 | ||
aa61d352 | 125 | \constfunc{bool}{IsChecked}{\param{unsigned int}{ item}} |
3972fb49 | 126 | |
cc81d32f | 127 | Returns true if the given item is checked, false otherwise. |
3972fb49 JS |
128 | |
129 | \wxheading{Parameters} | |
130 | ||
131 | \docparam{item}{Index of item whose check status is to be returned.} |