docs/latex/wx/bitmaptglbutn.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        bitmaptglbtn.tex
   3 %% Purpose:     wxBitmapToggleButton documentation
   4 %% Author:      Robert Roebling
   5 %% License:     wxWindows license
   6 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   7
   8 \section{\class{wxBitmapToggleButton}}\label{wxbitmaptogglebutton}
   9
  10 wxBitmapToggleButton is a a \helpref{wxToggleButton}{wxtogglebutton}
  11 that contains a bitmap instead of text.
  12
  13 This control emits a update UI event.
  14
  15 \wxheading{Derived from}
  16
  17 \helpref{wxControl}{wxcontrol}\\
  18 \helpref{wxWindow}{wxwindow}\\
  19 \helpref{wxEvtHandler}{wxevthandler}\\
  20 \helpref{wxObject}{wxobject}
  21
  22 \wxheading{Include files}
  23
  24 <wx/tglbtn.h>
  25
  26 \wxheading{Library}
  27
  28 \helpref{wxCore}{librarieslist}
  29
  30 \wxheading{Window styles}
  31
  32 There are no special styles for wxBitmapToggleButton.
  33
  34 \wxheading{Event handling}
  35
  36 \twocolwidtha{7cm}
  37 \begin{twocollist}\itemsep=0pt
  38 \twocolitem{{\bf EVT\_TOGGLEBUTTON(id, func)}}{Handles a toggle button click event.}
  39 \end{twocollist}
  40
  41 \latexignore{\rtfignore{\wxheading{Members}}}
  42
  43 \membersection{wxBitmapToggleButton::wxBitmapToggleButton}\label{wxbitmaptogglebuttonconstr}
  44
  45 \func{}{wxBitmapToggleButton}{\void}
  46
  47 Default constructor.
  48
  49 \func{}{wxBitmapToggleButton}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
  50 \param{const wxBitmap\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
  51 \param{const wxSize\& }{size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp
  52 \param{const wxValidator\& }{val}, \param{const wxString\& }{name = ``checkBox"}}
  53
  54 Constructor, creating and showing a toggle button with the bitmap {\it label}.
  55 Internally calls Create().
  56
  57 \membersection{wxBitmapToggleButton::Create}\label{wxbitmaptogglebuttoncreate}
  58
  59 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
  60 \param{const wxBitmap\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
  61 \param{const wxSize\& }{size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp
  62 \param{const wxValidator\& }{val}, \param{const wxString\& }{name = ``checkBox"}}
  63
  64 Create method for two-step construction.
  65
  66 \membersection{wxBitmapToggleButton::GetValue}\label{wxbitmaptogglebuttongetvalue}
  67
  68 \constfunc{bool}{GetValue}{\void}
  69
  70 Gets the state of the toggle button.
  71
  72 \wxheading{Return value}
  73
  74 Returns {\tt true} if it is pressed, {\tt false} otherwise.
  75
  76 \membersection{wxBitmapToggleButton::SetValue}\label{wxbitmaptogglebuttonsetvalue}
  77
  78 \func{void}{SetValue}{\param{bool}{ state}}
  79
  80 Sets the toggle button to the given state. This does not cause a
  81 {\tt EVT\_TOGGLEBUTTON} event to be emitted.
  82
  83 \wxheading{Parameters}
  84
  85 \docparam{state}{If {\tt true}, the button is pressed.}
  86