From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Sun, 26 May 2002 12:46:20 +0000 (+0000)
Subject: updated wxSpinXXX event docs
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/73c62f54176f802faed18a1e0ee78d64ad122da6

updated wxSpinXXX event docs


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@15675 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/latex/wx/spinbutt.tex b/docs/latex/wx/spinbutt.tex
index 3be1a60ec3..29467299af 100644
--- a/docs/latex/wx/spinbutt.tex
+++ b/docs/latex/wx/spinbutt.tex
@@ -7,7 +7,9 @@ as wxSpinButton is not implemented for all platforms (Win32 and GTK only
 currently).
 
 {\bf NB:} the range supported by this control (and wxSpinCtrl) depends on the
-platform but is at least {\tt SHRT\_MIN} to {\tt SHRT\_MAX}.
+platform but is at least {\tt -0x8000} to {\tt 0x7fff}. Under GTK and
+Win32 with sufficiently new version of {\tt comctrl32.dll} (at least 4.71 is
+required, 5.80 is recommended) the full 32 bit range is supported.
 
 \wxheading{Derived from}
 
@@ -36,18 +38,7 @@ platform but is at least {\tt SHRT\_MIN} to {\tt SHRT\_MAX}.
 
 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{wxSpinEvent}{wxspinevent} argument:
-
-\twocolwidtha{7cm}
-\begin{twocollist}
-\twocolitem{{\bf EVT\_SPIN(id, func)}}{Generated whenever an arrow 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}%
+\input spinevt.inc
 
 \wxheading{See also}
 
@@ -92,7 +83,7 @@ Constructor, creating and showing a spin button.
 
 \func{void}{\destruct{wxSpinButton}}{\void}
 
-Destructor, destroying the spin button.
+Destructor, destroys the spin button control.
 
 \membersection{wxSpinButton::Create}\label{wxspinbuttoncreate}
 
diff --git a/docs/latex/wx/spinctrl.tex b/docs/latex/wx/spinctrl.tex
index 4cf5aaa00a..da0c9befc5 100644
--- a/docs/latex/wx/spinctrl.tex
+++ b/docs/latex/wx/spinctrl.tex
@@ -34,9 +34,15 @@ functions that take a \helpref{wxSpinEvent}{wxspinevent} argument:
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf EVT\_SPINCTRL(id, func)}}{Generated whenever spinctrl is updated}
+\twocolitem{{\bf EVT\_SPINCTRL(id, func)}}{Generated whenever the numeric value
+of the spinctrl is updated}
 \end{twocollist}%
 
+You may also use the \helpref{wxSpinButton}{wxspinbutton} event macros, however
+the corresponding events will not be generated under all platforms. Finally, if
+the user modifies the text in the edit part of the spin control directly, the
+{\tt EVT\_TEXT} is generated, like for the \helpref{wxTextCtrl}{wxtextctrl}.
+
 \wxheading{See also}
 
 \helpref{Event handling overview}{eventhandlingoverview},
diff --git a/docs/latex/wx/spinevt.inc b/docs/latex/wx/spinevt.inc
new file mode 100644
index 0000000000..2523492edc
--- /dev/null
+++ b/docs/latex/wx/spinevt.inc
@@ -0,0 +1,28 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        spinevt.inc
+%% Purpose:     wxSpinEvent documentation shared between spinevt.tex and
+%%              spinbutt.tex
+%% Author:      Vadim Zeitlin
+%% Modified by:
+%% Created:     26.05.02 (extracted from spinbutt.tex)
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWindows team
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\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{wxSpinEvent}{wxspinevent} argument:
+
+\twocolwidtha{7cm}
+\begin{twocollist}
+\twocolitem{{\bf EVT\_SPIN(id, func)}}{Generated whenever an arrow 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}%
+
+Note that if you handle both SPIN and UP or DOWN events, you will be notified
+about each of them twice: first the UP/DOWN event will be receieved and then,
+if it wasn't vetoed, the SPIN event will be sent.
diff --git a/docs/latex/wx/spinevt.tex b/docs/latex/wx/spinevt.tex
index 6b063c96fb..9886823716 100644
--- a/docs/latex/wx/spinevt.tex
+++ b/docs/latex/wx/spinevt.tex
@@ -25,6 +25,8 @@ This event class is used for the events generated by
 
 <wx/spinbutt.h> or <wx/spinctrl.h>
 
+\input spinevt.inc
+
 \wxheading{See also}
 
 \helpref{wxSpinButton}{wxspinbutton} and \helpref{wxSpinCtrl}{wxspinctrl}