[wxWidgets.git] / docs / latex / wx / spinevt.inc

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% 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.
Commit	Line	Data
73c62f54 VZ	1	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
	2	%% Name: spinevt.inc
	3	%% Purpose: wxSpinEvent documentation shared between spinevt.tex and
	4	%% spinbutt.tex
	5	%% Author: Vadim Zeitlin
	6	%% Modified by:
	7	%% Created: 26.05.02 (extracted from spinbutt.tex)
	8	%% RCS-ID: $Id$
	9	%% Copyright: (c) wxWindows team
	10	%% License: wxWindows license
	11	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
	12
	13	\wxheading{Event handling}
	14
	15	To process input from a spin button, use one of these event handler macros to
	16	direct input to member functions that take a
	17	\helpref{wxSpinEvent}{wxspinevent} argument:
	18
	19	\twocolwidtha{7cm}
	20	\begin{twocollist}
	21	\twocolitem{{\bf EVT\_SPIN(id, func)}}{Generated whenever an arrow is pressed.}
	22	\twocolitem{{\bf EVT\_SPIN\_UP(id, func)}}{Generated when left/up arrow is pressed.}
	23	\twocolitem{{\bf EVT\_SPIN\_DOWN(id, func)}}{Generated when right/down arrow is pressed.}
	24	\end{twocollist}%
	25
	26	Note that if you handle both SPIN and UP or DOWN events, you will be notified
	27	about each of them twice: first the UP/DOWN event will be receieved and then,
	28	if it wasn't vetoed, the SPIN event will be sent.