added and documented wxDEFINE_SCOPED_PTR_TYPE; improved docs a bit

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

diff --git a/docs/latex/wx/checklst.tex b/docs/latex/wx/checklst.tex
index 8a328a4ff47d81977bfc40b4f5b8328d57a9ca8a..f2a296045a4da371a42ae32e2674a50e6857c9a1 100644 (file)
--- a/docs/latex/wx/checklst.tex
+++ b/docs/latex/wx/checklst.tex
@@ -2,8 +2,8 @@
 
 A checklistbox is like a listbox, but allows items to be checked or unchecked.
 
-This class is currently only implemented under Windows, and wxWindows must be
-compiled with USE\_OWNER\_DRAWN set to 1.
+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}.
 
@@ -15,13 +15,21 @@ Only the new functions for this class are documented; see also \helpref{wxListBo
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/checklst.h>
+
 \wxheading{Window styles}
 
 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}
 
@@ -64,6 +72,13 @@ 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
+a list of strings.}
+
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}.}
+
 \membersection{wxCheckListBox::\destruct{wxCheckListBox}}
 
 \func{void}{\destruct{wxCheckListBox}}{\void}
@@ -72,21 +87,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}