From d0a52e0bbda8c69f3af42634f993f48f819e8a26 Mon Sep 17 00:00:00 2001
From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Wed, 29 Mar 2000 14:46:00 +0000
Subject: [PATCH] corrected documentation of spin events, added wxSpinEvent
 class docs

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_2_BRANCH@6980 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/latex/wx/spinbutt.tex | 31 ++++++++++++-----------
 docs/latex/wx/spinctrl.tex |  2 +-
 docs/latex/wx/spinevt.tex  | 50 ++++++++++++++++++++++++++++++++++++++
 3 files changed, 66 insertions(+), 17 deletions(-)
 create mode 100644 docs/latex/wx/spinevt.tex

diff --git a/docs/latex/wx/spinbutt.tex b/docs/latex/wx/spinbutt.tex
index 21363e7504..3e9233eafd 100644
--- a/docs/latex/wx/spinbutt.tex
+++ b/docs/latex/wx/spinbutt.tex
@@ -1,7 +1,10 @@
 \section{\class{wxSpinButton}}\label{wxspinbutton}
 
-A wxSpinButton has two small up and down (or left and right) arrow buttons. It is often
-used next to a text control for increment and decrementing a value.
+A wxSpinButton has two small up and down (or left and right) arrow buttons. It
+is often used next to a text control for increment and decrementing a value.
+Portable programs should try to use \helpref{wxSpinCtrl}{wxspinctrl} instead
+as wxSpinButton is not implemented for all platforms (Win32 and GTK only
+currently).
 
 \wxheading{Derived from}
 
@@ -10,6 +13,10 @@ used next to a text control for increment and decrementing a value.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{See also}
+
+\helpref{wxSpinCtrl}{wxspinctrl} 
+
 \wxheading{Include files}
 
 <wx/spinbutt.h>
@@ -28,23 +35,15 @@ See also \helpref{window styles overview}{windowstyles}.
 
 \wxheading{Event handling}
 
-To process input from a spin button, use one of these event handler macros to direct input to member
-functions that take a \helpref{wxScrollEvent}{wxscrollevent} argument:
+To process input from a spin button, use one of these event handler macros to
+direct input to member functions that take a 
+\helpref{wxSpinEvent}{wxspinevent} argument:
 
 \twocolwidtha{7cm}
 \begin{twocollist}
-\twocolitem{{\bf EVT\_SPIN(id, func)}}{Catch all scroll commands.}
-\twocolitem{{\bf EVT\_SPIN\_UP(id, func)}}{Catch up (or left) commands. Win32 only. }
-\twocolitem{{\bf EVT\_SPIN\_DOWN(id, func)}}{Catch down (or right) commands. Win32 only. }
-\twocolitem{{\bf EVT\_COMMAND\_TOP(id, func)}}{Catch a command to put the scroll thumb at the maximum position.}
-\twocolitem{{\bf EVT\_COMMAND\_SCROLL(id, func)}}{Catch all scroll commands.}
-\twocolitem{{\bf EVT\_COMMAND\_TOP(id, func)}}{Catch a command to put the scroll thumb at the maximum position.}
-\twocolitem{{\bf EVT\_COMMAND\_BOTTOM(id, func)}}{Catch a command to put the scroll thumb at the maximum position.}
-\twocolitem{{\bf EVT\_COMMAND\_LINEUP(id, func)}}{Catch a line up command.}
-\twocolitem{{\bf EVT\_COMMAND\_LINEDOWN(id, func)}}{Catch a line down command.}
-\twocolitem{{\bf EVT\_COMMAND\_PAGEUP(id, func)}}{Catch a page up command.}
-\twocolitem{{\bf EVT\_COMMAND\_PAGEDOWN(id, func)}}{Catch a page down command.}
-\twocolitem{{\bf EVT\_COMMAND\_THUMBTRACK(id, func)}}{Catch a thumbtrack command (continuous movement of the scroll thumb).}
+\twocolitem{{\bf EVT\_SPIN(id, func)}}{Generated whenever an arros is pressed.}
+\twocolitem{{\bf EVT\_SPIN\_UP(id, func)}}{Generated when left/up arrow is pressed.}
+\twocolitem{{\bf EVT\_SPIN\_DOWN(id, func)}}{Generated when right/down arrow is pressed.}
 \end{twocollist}%
 
 \wxheading{See also}
diff --git a/docs/latex/wx/spinctrl.tex b/docs/latex/wx/spinctrl.tex
index 44570693f6..4cf5aaa00a 100644
--- a/docs/latex/wx/spinctrl.tex
+++ b/docs/latex/wx/spinctrl.tex
@@ -30,7 +30,7 @@ wxSpinCtrl combines \helpref{wxTextCtrl}{wxtextctrl} and
 \wxheading{Event handling}
 
 To process input from a spin button, use one of these event handler macros to direct input to member
-functions that take a \helpref{wxScrollEvent}{wxscrollevent} argument:
+functions that take a \helpref{wxSpinEvent}{wxspinevent} argument:
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
diff --git a/docs/latex/wx/spinevt.tex b/docs/latex/wx/spinevt.tex
new file mode 100644
index 0000000000..1f6ef1b8af
--- /dev/null
+++ b/docs/latex/wx/spinevt.tex
@@ -0,0 +1,50 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        spinevt.tex
+%% Purpose:     wxSpinEvent documentation
+%% Author:      Vadim Zeitlin
+%% Modified by:
+%% Created:     29.03.00
+%% RCS-ID:      $Id$
+%% Copyright:   (c) Vadim Zeitlin
+%% License:     wxWindows 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>
+
+\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.