wxWidgets/docs/latex/wx/spinevt.tex

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Name:        spinevt.tex
%% Purpose:     wxSpinEvent documentation
%% Author:      Vadim Zeitlin
%% Modified by:
%% Created:     29.03.00
%% RCS-ID:      $Id$
%% Copyright:   (c) Vadim Zeitlin
%% License:     wxWidgets license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\section{\class{wxSpinEvent}}\label{wxspinevent}

This event class is used for the events generated by 
\helpref{wxSpinButton}{wxspinbutton} and \helpref{wxSpinCtrl}{wxspinctrl}.

\wxheading{Derived from}

\helpref{wxNotifyEvent}{wxnotifyevent}\\
\helpref{wxCommandEvent}{wxcommandevent}\\
\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/spinbutt.h> or <wx/spinctrl.h>

\input spinevt.inc

\wxheading{See also}

\helpref{wxSpinButton}{wxspinbutton} and \helpref{wxSpinCtrl}{wxspinctrl}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxSpinEvent::wxSpinEvent}\label{wxspineventctor}

\func{}{wxSpinEvent}{\param{wxEventType }{commandType = wxEVT\_NULL}, \param{int }{id = 0}}

The constructor is not normally used by the user code.

\membersection{wxSpinEvent::GetPosition}\label{wxspineventgetposition}

\constfunc{int}{GetPosition}{\void}

Retrieve the current spin button or control value.

\membersection{wxSpinEvent::SetPosition}\label{wxspineventsetposition}

\func{void}{SetPosition}{\param{int }{pos}}

Set the value associated with the event.