]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/checklst.tex
Added wxRect::Intersect() documentation (patch 1868322 from Laurent Humbertclaude).
[wxWidgets.git] / docs / latex / wx / checklst.tex
index b1de4bfff70c70d3a138d4ad03b3f552a7789e28..dae20cfdd206f2b573dcc34e1905e0b331f4d139 100644 (file)
@@ -1,15 +1,29 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        checklst.tex
+%% Purpose:     wxCheckListBox documentation
+%% Author:      wxWidgets Team
+%% Modified by:
+%% Created:
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets Team
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \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.
+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}\\
+\helpref{wxControlWithItems}{wxcontrolwithitems}\\
 \helpref{wxControl}{wxcontrol}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
@@ -19,6 +33,10 @@ Only the new functions for this class are documented; see also \helpref{wxListBo
 
 <wx/checklst.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{Window styles}
 
 See \helpref{wxListBox}{wxlistbox}.
@@ -38,7 +56,7 @@ when an item in the check list box is checked or unchecked.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxCheckListBox::wxCheckListBox}\label{wxchecklistboxconstr}
+\membersection{wxCheckListBox::wxCheckListBox}\label{wxchecklistboxctor}
 
 \func{}{wxCheckListBox}{\void}
 
@@ -84,7 +102,7 @@ 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}}
+\membersection{wxCheckListBox::\destruct{wxCheckListBox}}\label{wxchecklistboxdtor}
 
 \func{void}{\destruct{wxCheckListBox}}{\void}
 
@@ -105,12 +123,10 @@ wxEVT\_COMMAND\_CHECKLISTBOX\_TOGGLE being emitted.
 
 \membersection{wxCheckListBox::IsChecked}\label{wxchecklistboxischecked}
 
-\constfunc{bool}{IsChecked}{\param{int}{ item}}
+\constfunc{bool}{IsChecked}{\param{unsigned 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.}
-
-