git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	\section{\class{wxSetCursorEvent}}\label{wxsetcursorevent}
	2
	3	A SetCursorEvent is generated when the mouse cursor is about to be set as a
	4	result of mouse motion. This event gives the application the chance to perform
	5	specific mouse cursor processing based on the current position of the mouse
	6	within the window. Use \helpref{SetCursor}{wxsetcursoreventsetcursor} to
	7	specify the cursor you want to be displayed.
	8
	9	\wxheading{Derived from}
	10
	11	\helpref{wxEvent}{wxevent}\\
	12	\helpref{wxObject}{wxobject}
	13
	14	\wxheading{Include files}
	15
	16	<wx/event.h>
	17
	18	\wxheading{Library}
	19
	20	\helpref{wxCore}{librarieslist}
	21
	22	\wxheading{See also}
	23
	24	\helpref{::wxSetCursor}{wxsetcursor}
	25	\helpref{wxWindow::wxSetCursor}{wxwindowsetcursor}
	26
	27	\wxheading{Event table macros}
	28
	29	To process a set cursor event, use this event handler macro to direct input to a member
	30	function that takes a wxSetCursorEvent argument.
	31
	32	\twocolwidtha{7cm}
	33	\begin{twocollist}\itemsep=0pt
	34	\twocolitem{{\bf EVT\_SET\_CURSOR(func)}}{Process a wxEVT\_SET\_CURSOR event.}
	35	\end{twocollist}%
	36
	37	\latexignore{\rtfignore{\wxheading{Members}}}
	38
	39
	40
	41	\membersection{wxSetCursorEvent::wxSetCursorEvent}\label{wxsetcursoreventctor}
	42
	43	\func{}{wxSetCursorEvent}{\param{wxCoord}{x = 0}, \param{wxCoord}{y = 0}}
	44
	45	Constructor, used by the library itself internally to initialize the event
	46	object.
	47
	48
	49	\membersection{wxSetCursorEvent::GetCursor}\label{wxsetcursoreventgetcursor}
	50
	51	\constfunc{wxCursor&}{GetCursor}{\void}
	52
	53	Returns a reference to the cursor specified by this event.
	54
	55
	56	\membersection{wxSetCursorEvent::GetX}\label{wxsetcursoreventgetx}
	57
	58	\constfunc{wxCoord}{GetX}{\void}
	59
	60	Returns the X coordinate of the mouse in client coordinates.
	61
	62
	63	\membersection{wxSetCursorEvent::GetY}\label{wxsetcursoreventgety}
	64
	65	\constfunc{wxCoord}{GetY}{\void}
	66
	67	Returns the Y coordinate of the mouse in client coordinates.
	68
	69
	70	\membersection{wxSetCursorEvent::HasCursor}\label{wxsetcursoreventhascursor}
	71
	72	\constfunc{bool}{HasCursor}{\void}
	73
	74	Returns \true if the cursor specified by this event is a valid cursor.
	75
	76	\wxheading{Remarks}
	77
	78	You cannot specify \texttt{wxNullCursor} with this event, as it is not
	79	considered a valid cursor.
	80
	81
	82	\membersection{wxSetCursorEvent::SetCursor}\label{wxsetcursoreventsetcursor}
	83
	84	\func{void}{SetCursor}{\param{const wxCursor\&}{cursor}}
	85
	86	Sets the cursor associated with this event.
	87
	88