]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/spinevt.tex
added and documented wxDEFINE_SCOPED_PTR_TYPE; improved docs a bit
[wxWidgets.git] / docs / latex / wx / spinevt.tex
CommitLineData
f6bcfd97
BP
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
14This 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
73c62f54
VZ
28\input spinevt.inc
29
f6bcfd97
BP
30\wxheading{See also}
31
32\helpref{wxSpinButton}{wxspinbutton} and \helpref{wxSpinCtrl}{wxspinctrl}
33
34\latexignore{\rtfignore{\wxheading{Members}}}
35
36\membersection{wxSpinEvent::wxSpinEvent}\label{wxspineventctor}
37
38\func{}{wxSpinEvent}{\param{wxEventType }{commandType = wxEVT\_NULL}, \param{int }{id = 0}}
39
40The constructor is not normally used by the user code.
41
42\membersection{wxSpinEvent::GetPosition}\label{wxspineventgetposition}
43
44\constfunc{int}{GetPosition}{\void}
45
46Retrieve the current spin button or control value.
47
48\membersection{wxSpinEvent::SetPosition}\label{wxspineventsetposition}
49
50\func{void}{SetPosition}{\param{int }{pos}}
51
52Set the value associated with the event.
53