[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{Window styles}

See \helpref{wxListBox}{wxlistbox}.

\wxheading{Event handling}

See \helpref{wxListBox}{wxlistbox}.

\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.}

\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
	18	\wxheading{Window styles}
	19
	20	See \helpref{wxListBox}{wxlistbox}.
	21
	22	\wxheading{Event handling}
	23
	24	See \helpref{wxListBox}{wxlistbox}.
	25
	26	\wxheading{See also}
	27
	28	\helpref{wxListBox}{wxlistbox}, \helpref{wxChoice}{wxchoice}, \helpref{wxComboBox}{wxcombobox}, \helpref{wxListCtrl}{wxlistctrl},
	29	\rtfsp\helpref{wxCommandEvent}{wxcommandevent}
	30
	31	\latexignore{\rtfignore{\wxheading{Members}}}
	32
	33	\membersection{wxCheckListBox::wxCheckListBox}\label{wxchecklistboxconstr}
	34
	35	\func{}{wxCheckListBox}{\void}
	36
	37	Default constructor.
	38
	39	\func{}{wxCheckListBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
	40	\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
	41	\param{int}{ n}, \param{const wxString }{choices[] = NULL},\rtfsp
	42	\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}}
	43
	44	Constructor, creating and showing a list box.
	45
	46	\wxheading{Parameters}
	47
	48	\docparam{parent}{Parent window. Must not be NULL.}
	49
	50	\docparam{id}{Window identifier. A value of -1 indicates a default value.}
	51
	52	\docparam{pos}{Window position.}
	53
	54	\docparam{size}{Window size. If the default size (-1, -1) is specified then the window is sized
	55	appropriately.}
	56
	57	\docparam{n}{Number of strings with which to initialise the control.}
	58
	59	\docparam{choices}{An array of strings with which to initialise the control.}
	60
	61	\docparam{style}{Window style. See \helpref{wxCheckListBox}{wxchecklistbox}.}
	62
	63	\docparam{validator}{Window validator.}
	64
	65	\docparam{name}{Window name.}
	66
	67	\membersection{wxCheckListBox::\destruct{wxCheckListBox}}
	68
	69	\func{void}{\destruct{wxCheckListBox}}{\void}
	70
71	Destructor, destroying the list box.
72
73	\membersection{wxCheckListBox::Check}\label{wxchecklistboxcheck}
74
75	\func{void}{Check}{\param{int }{item}, \param{bool}{ check = TRUE}}
76
77	Checks the given item.
78
79	\wxheading{Parameters}
80
81	\docparam{item}{Index of item to check.}
82
83	\docparam{check}{TRUE if the item is to be checked, FALSE otherwise.}
84
85	\membersection{wxCheckListBox::IsChecked}\label{wxchecklistboxischecked}
86
87	\constfunc{bool}{IsChecked}{\param{int}{ item}}
88
89	Returns TRUE if the given item is checked, FALSE otherwise.
90
91	\wxheading{Parameters}
92
93	\docparam{item}{Index of item whose check status is to be returned.}
94
95