Commited FRM's stockitem patch (empty stock items).

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

diff --git a/docs/latex/wx/checklst.tex b/docs/latex/wx/checklst.tex
index 1094fdb4e3f24e8f281ad9cb019d54e91b13fb62..8098222dc6e9700a9c926cd360f4f764072815aa 100644 (file)
--- a/docs/latex/wx/checklst.tex
+++ b/docs/latex/wx/checklst.tex
@@ -1,12 +1,25 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% 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.
 
 \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}.
 
 
 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}\\
 \wxheading{Derived from}
 
 \helpref{wxListBox}{wxlistbox}\\


@@ -27,7 +40,7 @@ See \helpref{wxListBox}{wxlistbox}.
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt

-\twocolitem{{\bf EVT\_CHECKLISTBOX(id, func)}}{Process a wxEVT\_COMMAND\_CHECKLISTBOX\_TOGGLE event,
+\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}
 
 when an item in the check list box is checked or unchecked.}
 \end{twocollist}
 


@@ -38,7 +51,7 @@ when an item in the check list box is checked or unchecked.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxCheckListBox::wxCheckListBox}\label{wxchecklistboxconstr}
+\membersection{wxCheckListBox::wxCheckListBox}\label{wxchecklistboxctor}

 
 \func{}{wxCheckListBox}{\void}
 
 
 \func{}{wxCheckListBox}{\void}
 


@@ -49,6 +62,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"}}
 
 \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}
 Constructor, creating and showing a list box.
 
 \wxheading{Parameters}


@@ -76,7 +94,10 @@ appropriately.}
 and {\tt choices} arguments are to a single argument, which is
 a list of strings.}
 
 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}
 
 
 \func{void}{\destruct{wxCheckListBox}}{\void}
 


@@ -84,24 +105,23 @@ 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}
 
 
 \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.
+Returns true if the given item is checked, false otherwise.

 
 \wxheading{Parameters}
 
 \docparam{item}{Index of item whose check status is to be returned.}
 
 \wxheading{Parameters}
 
 \docparam{item}{Index of item whose check status is to be returned.}

-
-