[wxWidgets.git] / docs / latex / wx / mcaptevt.tex

\section{\class{wxMouseCaptureChangedEvent}}\label{wxmousecapturechangedevent}

An mouse capture changed event is sent to a window that loses its
mouse capture. This is called even if wxWindow::ReleaseCapture
was called by the application code. Handling this event allows
an application to cater for unexpected capture releases which
might otherwise confuse mouse handling code.

This event is implemented under Windows only.

\wxheading{Derived from}

\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/event.h>

\wxheading{Event table macros}

To process this event, use the following event handler macro to direct input to a member
function that takes a wxMouseCaptureChangedEvent argument.

\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_MOUSE\_CAPTURE\_CHANGED(func)}}{Process a wxEVT\_MOUSE\_CAPTURE\_CHANGED event.}
\end{twocollist}

\wxheading{See also}

\helpref{Event handling overview}{eventhandlingoverview}, 
\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}, 
\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, 
\helpref{wxWindow::GetCapture}{wxwindowgetcapture}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxMouseCaptureChangedEvent::wxMouseCaptureChangedEvent}\label{wxmousecapturechangedeventctor}

\func{}{wxMouseCaptureChangedEvent}{\param{wxWindowID }{windowId = 0}, \param{wxWindow*}{ gainedCapture = NULL}}

Constructor.

\membersection{wxActivateEvent::GetCapturedWindow}\label{wxmousecapturechangedeventgetcapturedwindow}

\constfunc{wxWindow*}{GetCapturedWindow}{\void}

Returns the window that gained the capture, or NULL if it was a non-wxWidgets window.
Commit	Line	Data
a5e84126 JS	1	\section{\class{wxMouseCaptureChangedEvent}}\label{wxmousecapturechangedevent}
	2
	3	An mouse capture changed event is sent to a window that loses its
	4	mouse capture. This is called even if wxWindow::ReleaseCapture
	5	was called by the application code. Handling this event allows
	6	an application to cater for unexpected capture releases which
	7	might otherwise confuse mouse handling code.
	8
	9	This event is implemented under Windows only.
	10
	11	\wxheading{Derived from}
	12
	13	\helpref{wxEvent}{wxevent}\\
	14	\helpref{wxObject}{wxobject}
	15
	16	\wxheading{Include files}
	17
	18	<wx/event.h>
	19
	20	\wxheading{Event table macros}
	21
	22	To process this event, use the following event handler macro to direct input to a member
	23	function that takes a wxMouseCaptureChangedEvent argument.
	24
	25	\twocolwidtha{7cm}
	26	\begin{twocollist}\itemsep=0pt
	27	\twocolitem{{\bf EVT\_MOUSE\_CAPTURE\_CHANGED(func)}}{Process a wxEVT\_MOUSE\_CAPTURE\_CHANGED event.}
d2c2afc9	28	\end{twocollist}
a5e84126 JS	29
	30	\wxheading{See also}
	31
	32	\helpref{Event handling overview}{eventhandlingoverview},
	33	\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse},
	34	\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse},
	35	\helpref{wxWindow::GetCapture}{wxwindowgetcapture}
	36
	37	\latexignore{\rtfignore{\wxheading{Members}}}
	38
3e79fa75	39	\membersection{wxMouseCaptureChangedEvent::wxMouseCaptureChangedEvent}\label{wxmousecapturechangedeventctor}
a5e84126 JS	40
	41	\func{}{wxMouseCaptureChangedEvent}{\param{wxWindowID }{windowId = 0}, \param{wxWindow*}{ gainedCapture = NULL}}
	42
	43	Constructor.
	44
	45	\membersection{wxActivateEvent::GetCapturedWindow}\label{wxmousecapturechangedeventgetcapturedwindow}
	46
	47	\constfunc{wxWindow*}{GetCapturedWindow}{\void}
	48
fc2171bd	49	Returns the window that gained the capture, or NULL if it was a non-wxWidgets window.
a5e84126	50