[wxWidgets.git] / docs / latex / wx / checklst.tex

\section{\class{wxCheckListBox}}\label{wxchecklistbox}

A checklistbox is like a listbox, but allows items to be checked or unchecked.

This class is currently implemented under Windows and GTK. When using this
class under Windows wxWindows must be compiled with USE\_OWNER\_DRAWN set to 1.

Only the new functions for this class are documented; see also \helpref{wxListBox}{wxlistbox}.

\wxheading{Derived from}

\helpref{wxListBox}{wxlistbox}\\
\helpref{wxControl}{wxcontrol}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/checklst.h>

\wxheading{Window styles}

See \helpref{wxListBox}{wxlistbox}.

\wxheading{Event handling}

\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_CHECKLISTBOX(id, func)}}{Process a wxEVT\_COMMAND\_CHECKLISTBOX\_TOGGLE event,
when an item in the check list box is checked or unchecked.}
\end{twocollist}

\wxheading{See also}

\helpref{wxListBox}{wxlistbox}, \helpref{wxChoice}{wxchoice}, \helpref{wxComboBox}{wxcombobox}, \helpref{wxListCtrl}{wxlistctrl},
\rtfsp\helpref{wxCommandEvent}{wxcommandevent}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxCheckListBox::wxCheckListBox}\label{wxchecklistboxconstr}

\func{}{wxCheckListBox}{\void}

Default constructor.

\func{}{wxCheckListBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
\param{int}{ n}, \param{const wxString }{choices[] = NULL},\rtfsp
\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}}

Constructor, creating and showing a list box.

\wxheading{Parameters}

\docparam{parent}{Parent window. Must not be NULL.}

\docparam{id}{Window identifier. A value of -1 indicates a default value.}

\docparam{pos}{Window position.}

\docparam{size}{Window size. If the default size (-1, -1) is specified then the window is sized
appropriately.}

\docparam{n}{Number of strings with which to initialise the control.}

\docparam{choices}{An array of strings with which to initialise the control.}

\docparam{style}{Window style. See \helpref{wxCheckListBox}{wxchecklistbox}.}

\docparam{validator}{Window validator.}

\docparam{name}{Window name.}

\pythonnote{The wxCheckListBox constructor in wxPython reduces the {\tt n}
and {\tt choices} arguments are to a single argument, which is
a list of strings.}

\membersection{wxCheckListBox::\destruct{wxCheckListBox}}

\func{void}{\destruct{wxCheckListBox}}{\void}

Destructor, destroying the list box.

\membersection{wxCheckListBox::Check}\label{wxchecklistboxcheck}

\func{void}{Check}{\param{int }{item}, \param{bool}{ check = TRUE}}

Checks the given item.

\wxheading{Parameters}

\docparam{item}{Index of item to check.}

\docparam{check}{TRUE if the item is to be checked, FALSE otherwise.}

\membersection{wxCheckListBox::IsChecked}\label{wxchecklistboxischecked}

\constfunc{bool}{IsChecked}{\param{int}{ item}}

Returns TRUE if the given item is checked, FALSE otherwise.

\wxheading{Parameters}

\docparam{item}{Index of item whose check status is to be returned.}
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
12a44087 RR	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
dd3c394a VZ	28	\twocolwidtha{7cm}
	29	\begin{twocollist}\itemsep=0pt
	30	\twocolitem{{\bf EVT\_CHECKLISTBOX(id, func)}}{Process a wxEVT\_COMMAND\_CHECKLISTBOX\_TOGGLE event,
	31	when an item in the check list box is checked or unchecked.}
	32	\end{twocollist}
3972fb49 JS	33
	34	\wxheading{See also}
	35
	36	\helpref{wxListBox}{wxlistbox}, \helpref{wxChoice}{wxchoice}, \helpref{wxComboBox}{wxcombobox}, \helpref{wxListCtrl}{wxlistctrl},
	37	\rtfsp\helpref{wxCommandEvent}{wxcommandevent}
	38
	39	\latexignore{\rtfignore{\wxheading{Members}}}
	40
	41	\membersection{wxCheckListBox::wxCheckListBox}\label{wxchecklistboxconstr}
	42
	43	\func{}{wxCheckListBox}{\void}
	44
	45	Default constructor.
	46
	47	\func{}{wxCheckListBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
	48	\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
	49	\param{int}{ n}, \param{const wxString }{choices[] = NULL},\rtfsp
	50	\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}}
	51
	52	Constructor, creating and showing a list box.
	53
	54	\wxheading{Parameters}
	55
	56	\docparam{parent}{Parent window. Must not be NULL.}
	57
	58	\docparam{id}{Window identifier. A value of -1 indicates a default value.}
	59
	60	\docparam{pos}{Window position.}
	61
	62	\docparam{size}{Window size. If the default size (-1, -1) is specified then the window is sized
	63	appropriately.}
	64
	65	\docparam{n}{Number of strings with which to initialise the control.}
	66
	67	\docparam{choices}{An array of strings with which to initialise the control.}
	68
	69	\docparam{style}{Window style. See \helpref{wxCheckListBox}{wxchecklistbox}.}
	70
	71	\docparam{validator}{Window validator.}
	72
	73	\docparam{name}{Window name.}
	74
c9110876 VS	75	\pythonnote{The wxCheckListBox constructor in wxPython reduces the {\tt n}
c9110876 VS	76	and {\tt choices} arguments are to a single argument, which is
06d20283 RD	77	a list of strings.}
06d20283 RD	78
3972fb49 JS	79	\membersection{wxCheckListBox::\destruct{wxCheckListBox}}
	80
	81	\func{void}{\destruct{wxCheckListBox}}{\void}
	82
	83	Destructor, destroying the list box.
	84
	85	\membersection{wxCheckListBox::Check}\label{wxchecklistboxcheck}
	86
	87	\func{void}{Check}{\param{int }{item}, \param{bool}{ check = TRUE}}
	88
	89	Checks the given item.
	90
	91	\wxheading{Parameters}
	92
	93	\docparam{item}{Index of item to check.}
	94
	95	\docparam{check}{TRUE if the item is to be checked, FALSE otherwise.}
	96
	97	\membersection{wxCheckListBox::IsChecked}\label{wxchecklistboxischecked}
	98
	99	\constfunc{bool}{IsChecked}{\param{int}{ item}}
	100
	101	Returns TRUE if the given item is checked, FALSE otherwise.
	102
	103	\wxheading{Parameters}
	104
	105	\docparam{item}{Index of item whose check status is to be returned.}
	106
	107