docs/latex/wx/checklst.tex

   1 \section{\class{wxCheckListBox}}\label{wxchecklistbox}
   2
   3 A checklistbox is like a listbox, but allows items to be checked or unchecked.
   4
   5 This class is currently implemented under Windows and GTK. When using this
   6 class under Windows wxWindows must be compiled with USE\_OWNER\_DRAWN set to 1.
   7
   8 Only the new functions for this class are documented; see also \helpref{wxListBox}{wxlistbox}.
   9
  10 \wxheading{Derived from}
  11
  12 \helpref{wxListBox}{wxlistbox}\\
  13 \helpref{wxControl}{wxcontrol}\\
  14 \helpref{wxWindow}{wxwindow}\\
  15 \helpref{wxEvtHandler}{wxevthandler}\\
  16 \helpref{wxObject}{wxobject}
  17
  18 \wxheading{Include files}
  19
  20 <wx/checklst.h>
  21
  22 \wxheading{Window styles}
  23
  24 See \helpref{wxListBox}{wxlistbox}.
  25
  26 \wxheading{Event handling}
  27
  28 See \helpref{wxListBox}{wxlistbox}.
  29
  30 \wxheading{See also}
  31
  32 \helpref{wxListBox}{wxlistbox}, \helpref{wxChoice}{wxchoice}, \helpref{wxComboBox}{wxcombobox}, \helpref{wxListCtrl}{wxlistctrl},
  33 \rtfsp\helpref{wxCommandEvent}{wxcommandevent}
  34
  35 \latexignore{\rtfignore{\wxheading{Members}}}
  36
  37 \membersection{wxCheckListBox::wxCheckListBox}\label{wxchecklistboxconstr}
  38
  39 \func{}{wxCheckListBox}{\void}
  40
  41 Default constructor.
  42
  43 \func{}{wxCheckListBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
  44 \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
  45 \param{int}{ n}, \param{const wxString }{choices[] = NULL},\rtfsp
  46 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}}
  47
  48 Constructor, creating and showing a list box.
  49
  50 \wxheading{Parameters}
  51
  52 \docparam{parent}{Parent window. Must not be NULL.}
  53
  54 \docparam{id}{Window identifier. A value of -1 indicates a default value.}
  55
  56 \docparam{pos}{Window position.}
  57
  58 \docparam{size}{Window size. If the default size (-1, -1) is specified then the window is sized
  59 appropriately.}
  60
  61 \docparam{n}{Number of strings with which to initialise the control.}
  62
  63 \docparam{choices}{An array of strings with which to initialise the control.}
  64
  65 \docparam{style}{Window style. See \helpref{wxCheckListBox}{wxchecklistbox}.}
  66
  67 \docparam{validator}{Window validator.}
  68
  69 \docparam{name}{Window name.}
  70
  71 \pythonnote{The wxCheckListBox constructor in wxPython reduces the \tt{n}
  72 and \tt{choices} arguments are to a single argument, which is
  73 a list of strings.}
  74
  75 \membersection{wxCheckListBox::\destruct{wxCheckListBox}}
  76
  77 \func{void}{\destruct{wxCheckListBox}}{\void}
  78
  79 Destructor, destroying the list box.
  80
  81 \membersection{wxCheckListBox::Check}\label{wxchecklistboxcheck}
  82
  83 \func{void}{Check}{\param{int }{item}, \param{bool}{ check = TRUE}}
  84
  85 Checks the given item.
  86
  87 \wxheading{Parameters}
  88
  89 \docparam{item}{Index of item to check.}
  90
  91 \docparam{check}{TRUE if the item is to be checked, FALSE otherwise.}
  92
  93 \membersection{wxCheckListBox::IsChecked}\label{wxchecklistboxischecked}
  94
  95 \constfunc{bool}{IsChecked}{\param{int}{ item}}
  96
  97 Returns TRUE if the given item is checked, FALSE otherwise.
  98
  99 \wxheading{Parameters}
 100
 101 \docparam{item}{Index of item whose check status is to be returned.}
 102
 103