X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc81d32f2bf8c159f3b1bf6ddaf62e6d77720209..5e1fd3eb6103c8f91bcec37ddffe322b8ddbfaa5:/docs/latex/wx/checklst.tex diff --git a/docs/latex/wx/checklst.tex b/docs/latex/wx/checklst.tex index c88c7c0641..8098222dc6 100644 --- 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. -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}\\ @@ -27,7 +40,7 @@ See \helpref{wxListBox}{wxlistbox}. \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} @@ -38,7 +51,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} @@ -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"}} +\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} @@ -79,7 +97,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} @@ -100,12 +118,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.} - -