]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/mcaptevt.tex
escape underscores to fix the docs build
[wxWidgets.git] / docs / latex / wx / mcaptevt.tex
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.}
28 \end{twocollist}
29
30 \wxheading{See also}
31
32 \helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent}
33 \helpref{Event handling overview}{eventhandlingoverview},
34 \helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse},
35 \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse},
36 \helpref{wxWindow::GetCapture}{wxwindowgetcapture}
37
38 \latexignore{\rtfignore{\wxheading{Members}}}
39
40 \membersection{wxMouseCaptureChangedEvent::wxMouseCaptureChangedEvent}\label{wxmousecapturechangedeventctor}
41
42 \func{}{wxMouseCaptureChangedEvent}{\param{wxWindowID }{windowId = 0}, \param{wxWindow*}{ gainedCapture = NULL}}
43
44 Constructor.
45
46 \membersection{wxActivateEvent::GetCapturedWindow}\label{wxmousecapturechangedeventgetcapturedwindow}
47
48 \constfunc{wxWindow*}{GetCapturedWindow}{\void}
49
50 Returns the window that gained the capture, or NULL if it was a non-wxWidgets window.
51
52
53 \section{\class{wxMouseCaptureLostEvent}}\label{wxmousecapturelostevent}
54
55 An mouse capture lost event is sent to a window that obtained mouse capture,
56 which was subsequently loss due to "external" event, for example when a dialog
57 box is shown or if another application captures the mouse.
58
59 If this happens, this event is sent to all windows that are on capture stack
60 (i.e. called CaptureMouse, but didn't call ReleaseMouse yet). The event is
61 {\em not} sent if the capture changes because of a call to CaptureMouse or
62 ReleaseMouse.
63
64 This event is currently emitted under Windows only.
65
66 \wxheading{Derived from}
67
68 \helpref{wxEvent}{wxevent}\\
69 \helpref{wxObject}{wxobject}
70
71 \wxheading{Include files}
72
73 <wx/event.h>
74
75 \wxheading{Event table macros}
76
77 To process this event, use the following event handler macro to direct input to
78 a member function that takes a wxMouseCaptureLostEvent argument.
79
80 \twocolwidtha{7cm}
81 \begin{twocollist}\itemsep=0pt
82 \twocolitem{{\bf EVT\_MOUSE\_CAPTURE\_LOST(func)}}{Process a wxEVT\_MOUSE\_CAPTURE\_LOST event.}
83 \end{twocollist}
84
85 \wxheading{See also}
86
87 \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
88 \helpref{Event handling overview}{eventhandlingoverview},
89 \helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse},
90 \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse},
91 \helpref{wxWindow::GetCapture}{wxwindowgetcapture}
92
93 \latexignore{\rtfignore{\wxheading{Members}}}
94
95 \membersection{wxMouseCaptureLostEvent::wxMouseCaptureLostEvent}\label{wxmousecapturelosteventctor}
96
97 \func{}{wxMouseCaptureLostEvent}{\param{wxWindowID }{windowId = 0}}
98
99 Constructor.
100