X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12a44087e448071f9f108208a0a88e908d543d44..066f3611df971be93b2ec46b82c2f05f3ff9a422:/docs/latex/wx/checklst.tex?ds=sidebyside diff --git a/docs/latex/wx/checklst.tex b/docs/latex/wx/checklst.tex index 9785a48601..dae20cfdd2 100644 --- a/docs/latex/wx/checklst.tex +++ b/docs/latex/wx/checklst.tex @@ -1,27 +1,53 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% 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}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \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} @@ -30,7 +56,7 @@ See \helpref{wxListBox}{wxlistbox}. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxCheckListBox::wxCheckListBox}\label{wxchecklistboxconstr} +\membersection{wxCheckListBox::wxCheckListBox}\label{wxchecklistboxctor} \func{}{wxCheckListBox}{\void} @@ -41,6 +67,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} @@ -64,7 +95,14 @@ appropriately.} \docparam{name}{Window name.} -\membersection{wxCheckListBox::\destruct{wxCheckListBox}} +\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}}\label{wxchecklistboxdtor} \func{void}{\destruct{wxCheckListBox}}{\void} @@ -72,24 +110,23 @@ 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}} +\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.} - -