Introduced the ability to size a book control based on the currently selected page

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

diff --git a/docs/latex/wx/checklst.tex b/docs/latex/wx/checklst.tex
index c0a6f956a064b93546e1c9318f349e9712e43f96..4fceff32ec33353d5314bab7b28644182f55c747 100644 (file)
--- a/docs/latex/wx/checklst.tex
+++ b/docs/latex/wx/checklst.tex
@@ -2,11 +2,13 @@
 
 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.
+When using this class under Windows wxWidgets must be compiled with USE\_OWNER\_DRAWN set to 1.
 
 Only the new functions for this class are documented; see also \helpref{wxListBox}{wxlistbox}.
 
+Please note that wxCheckListBox uses client data in its implementation,
+and therefore this is not available to the application.
+
 \wxheading{Derived from}
 
 \helpref{wxListBox}{wxlistbox}\\
@@ -25,7 +27,11 @@ See \helpref{wxListBox}{wxlistbox}.
 
 \wxheading{Event handling}
 
-See \helpref{wxListBox}{wxlistbox}.
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_CHECKLISTBOX(id, func)}}{Process a wxEVT\_COMMAND\_CHECKLISTBOX\_TOGGLED event,
+when an item in the check list box is checked or unchecked.}
+\end{twocollist}
 
 \wxheading{See also}
 
@@ -34,7 +40,7 @@ See \helpref{wxListBox}{wxlistbox}.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxCheckListBox::wxCheckListBox}\label{wxchecklistboxconstr}
+\membersection{wxCheckListBox::wxCheckListBox}\label{wxchecklistboxctor}
 
 \func{}{wxCheckListBox}{\void}
 
@@ -45,6 +51,11 @@ Default constructor.
 \param{int}{ n}, \param{const wxString }{choices[] = NULL},\rtfsp
 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}}
 
+\func{}{wxCheckListBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
+\param{const wxPoint\&}{ pos}, \param{const wxSize\&}{ size},\rtfsp
+\param{const wxArrayString\& }{choices},\rtfsp
+\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}}
+
 Constructor, creating and showing a list box.
 
 \wxheading{Parameters}
@@ -68,11 +79,14 @@ appropriately.}
 
 \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
+\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}}
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}.}
+
+\membersection{wxCheckListBox::\destruct{wxCheckListBox}}\label{wxchecklistboxdtor}
 
 \func{void}{\destruct{wxCheckListBox}}{\void}
 
@@ -80,21 +94,22 @@ Destructor, destroying the list box.
 
 \membersection{wxCheckListBox::Check}\label{wxchecklistboxcheck}
 
-\func{void}{Check}{\param{int }{item}, \param{bool}{ check = TRUE}}
+\func{void}{Check}{\param{int }{item}, \param{bool}{ check = true}}
 
-Checks the given item.
+Checks the given item. Note that calling this method doesn't result in
+wxEVT\_COMMAND\_CHECKLISTBOX\_TOGGLE being emitted.
 
 \wxheading{Parameters}
 
 \docparam{item}{Index of item to check.}
 
-\docparam{check}{TRUE if the item is to be checked, FALSE otherwise.}
+\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.
+Returns true if the given item is checked, false otherwise.
 
 \wxheading{Parameters}