Applied patch [ 827011 ] Event-based processing of item tooltips in wxTreeCtrl

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

diff --git a/docs/latex/wx/checklst.tex b/docs/latex/wx/checklst.tex
index c0a6f956a064b93546e1c9318f349e9712e43f96..f2a296045a4da371a42ae32e2674a50e6857c9a1 100644 (file)
--- a/docs/latex/wx/checklst.tex
+++ b/docs/latex/wx/checklst.tex
@@ -25,7 +25,11 @@ See \helpref{wxListBox}{wxlistbox}.
 
 \wxheading{Event handling}
 
 
 \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}
 
 
 \wxheading{See also}
 


@@ -68,10 +72,13 @@ appropriately.}
 
 \docparam{name}{Window name.}
 
 
 \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.}
 
 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}
 \membersection{wxCheckListBox::\destruct{wxCheckListBox}}
 
 \func{void}{\destruct{wxCheckListBox}}{\void}


@@ -80,21 +87,22 @@ Destructor, destroying the list box.
 
 \membersection{wxCheckListBox::Check}\label{wxchecklistboxcheck}
 
 
 \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.}
 
 
 \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}}
 
 
 \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}
 
 
 \wxheading{Parameters}