projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 15b0d048 VZ |
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{See also} | |
| 19 | ||
| 20 | \helpref{::wxSetCursor}{wxsetcursor} | |
| 21 | \helpref{wxWindow::wxSetCursor}{wxwindowsetcursor} | |
| 22 | ||
| 23 | \wxheading{Event table macros} | |
| 24 | ||
| 25 | To process a set cursor event, use this event handler macro to direct input to a member | |
| 26 | function that takes a wxSetCursorEvent argument. | |
| 27 | ||
| 28 | \twocolwidtha{7cm} | |
| 29 | \begin{twocollist}\itemsep=0pt | |
| 30 | \twocolitem{{\bf EVT\_SET\_CURSOR(func)}}{Process a wxEVT\_SET\_CURSOR event.} | |
| 31 | \end{twocollist}% | |
| 32 | ||
| 33 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 34 | ||
| 35 | ||
| 36 | ||
| 37 | \membersection{wxSetCursorEvent::wxSetCursorEvent}\label{wxsetcursoreventctor} | |
| 38 | ||
| 39 | \func{}{wxSetCursorEvent}{\param{wxCoord}{x = 0}, \param{wxCoord}{y = 0}} | |
| 40 | ||
| 41 | Constructor, used by the library itself internally to initialize the event | |
| 42 | object. | |
| 43 | ||
| 44 | ||
| 45 | \membersection{wxSetCursorEvent::GetCursor}\label{wxsetcursoreventgetcursor} | |
| 46 | ||
| 47 | \constfunc{wxCursor&}{GetCursor}{\void} | |
| 48 | ||
| 49 | Returns a reference to the cursor specified by this event. | |
| 50 | ||
| 51 | ||
| 52 | \membersection{wxSetCursorEvent::GetX}\label{wxsetcursoreventgetx} | |
| 53 | ||
| 54 | \constfunc{wxCoord}{GetX}{\void} | |
| 55 | ||
| 56 | Returns the X coordinate of the mouse in client coordinates. | |
| 57 | ||
| 58 | ||
| 59 | \membersection{wxSetCursorEvent::GetY}\label{wxsetcursoreventgety} | |
| 60 | ||
| 61 | \constfunc{wxCoord}{GetY}{\void} | |
| 62 | ||
| 63 | Returns the Y coordinate of the mouse in client coordinates. | |
| 64 | ||
| 65 | ||
| 66 | \membersection{wxSetCursorEvent::HasCursor}\label{wxsetcursoreventhascursor} | |
| 67 | ||
| 68 | \constfunc{bool}{HasCursor}{\void} | |
| 69 | ||
| 70 | Returns \true if the cursor specified by this event is a valid cursor. | |
| 71 | ||
| 72 | \wxheading{Remarks} | |
| 73 | ||
| 74 | You cannot specify \texttt{wxNullCursor} with this event, as it is not | |
| 75 | considered a valid cursor. | |
| 76 | ||
| 77 | ||
| 78 | \membersection{wxSetCursorEvent::SetCursor}\label{wxsetcursoreventsetcursor} | |
| 79 | ||
| 80 | \func{void}{SetCursor}{\param{const wxCursor\&}{cursor}} | |
| 81 | ||
| 82 | Sets the cursor associated with this event. | |
| 83 | ||
| 84 |