docs/latex/wx/spinevt.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        spinevt.tex
   3 %% Purpose:     wxSpinEvent documentation
   4 %% Author:      Vadim Zeitlin
   5 %% Modified by:
   6 %% Created:     29.03.00
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) Vadim Zeitlin
   9 %% License:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxSpinEvent}}\label{wxspinevent}
  13
  14 This event class is used for the events generated by
  15 \helpref{wxSpinButton}{wxspinbutton} and \helpref{wxSpinCtrl}{wxspinctrl}.
  16
  17 \wxheading{Derived from}
  18
  19 \helpref{wxNotifyEvent}{wxnotifyevent}\\
  20 \helpref{wxCommandEvent}{wxcommandevent}\\
  21 \helpref{wxEvent}{wxevent}\\
  22 \helpref{wxObject}{wxobject}
  23
  24 \wxheading{Include files}
  25
  26 <wx/spinbutt.h> or <wx/spinctrl.h>
  27
  28 \wxheading{Library}
  29
  30 \helpref{wxCore}{librarieslist}
  31
  32 \input spinevt.inc
  33
  34 \wxheading{See also}
  35
  36 \helpref{wxSpinButton}{wxspinbutton} and \helpref{wxSpinCtrl}{wxspinctrl}
  37
  38 \latexignore{\rtfignore{\wxheading{Members}}}
  39
  40 \membersection{wxSpinEvent::wxSpinEvent}\label{wxspineventctor}
  41
  42 \func{}{wxSpinEvent}{\param{wxEventType }{commandType = wxEVT\_NULL}, \param{int }{id = 0}}
  43
  44 The constructor is not normally used by the user code.
  45
  46 \membersection{wxSpinEvent::GetPosition}\label{wxspineventgetposition}
  47
  48 \constfunc{int}{GetPosition}{\void}
  49
  50 Retrieve the current spin button or control value.
  51
  52 \membersection{wxSpinEvent::SetPosition}\label{wxspineventsetposition}
  53
  54 \func{void}{SetPosition}{\param{int }{pos}}
  55
  56 Set the value associated with the event.
  57