updated wxSpinXXX event docs

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@15675 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2002-05-26 12:46:20 +00:00
parent 3d9fe7b26d
commit 73c62f5417
4 changed files with 42 additions and 15 deletions

View File

@@ -7,7 +7,9 @@ as wxSpinButton is not implemented for all platforms (Win32 and GTK only
currently). currently).
{\bf NB:} the range supported by this control (and wxSpinCtrl) depends on the {\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} \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}. See also \helpref{window styles overview}{windowstyles}.
\wxheading{Event handling} \input spinevt.inc
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}%
\wxheading{See also} \wxheading{See also}
@@ -92,7 +83,7 @@ Constructor, creating and showing a spin button.
\func{void}{\destruct{wxSpinButton}}{\void} \func{void}{\destruct{wxSpinButton}}{\void}
Destructor, destroying the spin button. Destructor, destroys the spin button control.
\membersection{wxSpinButton::Create}\label{wxspinbuttoncreate} \membersection{wxSpinButton::Create}\label{wxspinbuttoncreate}

View File

@@ -34,9 +34,15 @@ functions that take a \helpref{wxSpinEvent}{wxspinevent} argument:
\twocolwidtha{7cm} \twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt \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}% \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} \wxheading{See also}
\helpref{Event handling overview}{eventhandlingoverview}, \helpref{Event handling overview}{eventhandlingoverview},

28
docs/latex/wx/spinevt.inc Normal file
View File

@@ -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.

View File

@@ -25,6 +25,8 @@ This event class is used for the events generated by
<wx/spinbutt.h> or <wx/spinctrl.h> <wx/spinbutt.h> or <wx/spinctrl.h>
\input spinevt.inc
\wxheading{See also} \wxheading{See also}
\helpref{wxSpinButton}{wxspinbutton} and \helpref{wxSpinCtrl}{wxspinctrl} \helpref{wxSpinButton}{wxspinbutton} and \helpref{wxSpinCtrl}{wxspinctrl}