From 15b0d048899fb1b33588a2a6d6aa3c25f4a75ac1 Mon Sep 17 00:00:00 2001
From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Sat, 16 Oct 2004 19:59:04 +0000
Subject: [PATCH] added wxSetCursorEvent documentation (patch 1048181)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@29922 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/latex/wx/classes.tex      |  1 +
 docs/latex/wx/setcursorevt.tex | 84 ++++++++++++++++++++++++++++++++++
 docs/latex/wx/tevent.tex       |  2 +
 3 files changed, 87 insertions(+)
 create mode 100644 docs/latex/wx/setcursorevt.tex

diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex
index 08e08887b4..a53b95fea4 100644
--- a/docs/latex/wx/classes.tex
+++ b/docs/latex/wx/classes.tex
@@ -268,6 +268,7 @@
 \input scrolevt.tex
 \input scrlwevt.tex
 \input semaphor.tex
+\input setcursorevt.tex
 \input ipcservr.tex
 \input hprovsmp.tex
 \input sngchdlg.tex
diff --git a/docs/latex/wx/setcursorevt.tex b/docs/latex/wx/setcursorevt.tex
new file mode 100644
index 0000000000..3ac3b1a7c9
--- /dev/null
+++ b/docs/latex/wx/setcursorevt.tex
@@ -0,0 +1,84 @@
+\section{\class{wxSetCursorEvent}}\label{wxsetcursorevent}
+
+A SetCursorEvent is generated when the mouse cursor is about to be set as a
+result of mouse motion. This event gives the application the chance to perform
+specific mouse cursor processing based on the current position of the mouse
+within the window. Use \helpref{SetCursor}{wxsetcursoreventsetcursor} to
+specify the cursor you want to be displayed.
+
+\wxheading{Derived from}
+
+\helpref{wxEvent}{wxevent}\\
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/event.h>
+
+\wxheading{See also}
+
+\helpref{::wxSetCursor}{wxsetcursor}
+\helpref{wxWindow::wxSetCursor}{wxwindowsetcursor}
+
+\wxheading{Event table macros}
+
+To process a set cursor event, use this event handler macro to direct input to a member
+function that takes a wxSetCursorEvent argument.
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_SET\_CURSOR(func)}}{Process a wxEVT\_SET\_CURSOR event.}
+\end{twocollist}%
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+
+\membersection{wxSetCursorEvent::wxSetCursorEvent}\label{wxsetcursoreventctor}
+
+\func{}{wxSetCursorEvent}{\param{wxCoord}{x = 0}, \param{wxCoord}{y = 0}}
+
+Constructor, used by the library itself internally to initialize the event
+object.
+
+
+\membersection{wxSetCursorEvent::GetCursor}\label{wxsetcursoreventgetcursor}
+
+\constfunc{wxCursor&}{GetCursor}{\void}
+
+Returns a reference to the cursor specified by this event.
+
+
+\membersection{wxSetCursorEvent::GetX}\label{wxsetcursoreventgetx}
+
+\constfunc{wxCoord}{GetX}{\void}
+
+Returns the X coordinate of the mouse in client coordinates.
+
+
+\membersection{wxSetCursorEvent::GetY}\label{wxsetcursoreventgety}
+
+\constfunc{wxCoord}{GetY}{\void}
+
+Returns the Y coordinate of the mouse in client coordinates.
+
+
+\membersection{wxSetCursorEvent::HasCursor}\label{wxsetcursoreventhascursor}
+
+\constfunc{bool}{HasCursor}{\void}
+
+Returns \true if the cursor specified by this event is a valid cursor.
+
+\wxheading{Remarks}
+
+You cannot specify \texttt{wxNullCursor} with this event, as it is not
+considered a valid cursor.
+
+
+\membersection{wxSetCursorEvent::SetCursor}\label{wxsetcursoreventsetcursor}
+
+\func{void}{SetCursor}{\param{const wxCursor\&}{cursor}}
+
+Sets the cursor associated with this event.
+
+
diff --git a/docs/latex/wx/tevent.tex b/docs/latex/wx/tevent.tex
index 1ede2e9e60..598878746f 100644
--- a/docs/latex/wx/tevent.tex
+++ b/docs/latex/wx/tevent.tex
@@ -207,6 +207,7 @@ here is a list of system events which will NOT get sent to the parent's event ha
 \twocolitem{\helpref{wxMoveEvent}{wxmoveevent}}{A move event}
 \twocolitem{\helpref{wxPaintEvent}{wxpaintevent}}{A paint event}
 \twocolitem{\helpref{wxQueryLayoutInfoEvent}{wxquerylayoutinfoevent}}{Used to query layout information}
+\twocolitem{\helpref{wxSetCursorEvent}{wxsetcursorevent}}{Used for special cursor processing based on current mouse position}
 \twocolitem{\helpref{wxSizeEvent}{wxsizeevent}}{A size event}
 \twocolitem{\helpref{wxScrollWinEvent}{wxscrollwinevent}}{A scroll event sent by a scrolled window (not a scroll bar)}
 \twocolitem{\helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}}{A system colour change event}
@@ -400,6 +401,7 @@ mouse events or all mouse events.}
 \twocolitem{\helpref{wxPaintEvent}{wxpaintevent}}{The EVT\_PAINT macro is used to handle window paint requests.}
 \twocolitem{\helpref{wxScrollEvent}{wxscrollevent}}{These macros are used to handle scroll events from 
 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxSlider}{wxslider},and \helpref{wxSpinButton}{wxspinbutton}.}
+\twocolitem{\helpref{wxSetCursorEvent}{wxsetcursorevent}}{The EVT\_SET\_CURSOR macro is used for special cursor processing.}
 \twocolitem{\helpref{wxSizeEvent}{wxsizeevent}}{The EVT\_SIZE macro is used to handle a window resize.}
 \twocolitem{\helpref{wxSplitterEvent}{wxsplitterevent}}{The EVT\_SPLITTER\_SASH\_POS\_CHANGED, EVT\_SPLITTER\_UNSPLIT
 and EVT\_SPLITTER\_DCLICK macros are used to handle the various splitter window events.}
-- 
2.50.0

