View Source wxSetCursorEvent (wx v2.4.2)
Functions for wxSetCursorEvent class
A wxSetCursorEvent is generated from wxWindow 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
setCursor/2 to specify the cursor you want to be displayed.
See: wx_misc:setCursor/1, wxWindow:setCursor/2
This class is derived (and can use functions) from: wxEvent
wxWidgets docs: wxSetCursorEvent
Events
Use wxEvtHandler:connect/3 with
wxSetCursorEventType to subscribe to events of
this type.
Summary
Functions
Returns a reference to the cursor specified by this event.
Returns the X coordinate of the mouse in client coordinates.
Returns the Y coordinate of the mouse in client coordinates.
Returns true if the cursor specified by this event is a valid cursor.
Sets the cursor associated with this event.
Types
-type wxSetCursor() :: #wxSetCursor{type :: wxSetCursorEvent:wxSetCursorEventType(), x :: integer(), y :: integer(), cursor :: wxCursor:wxCursor()}.
-type wxSetCursorEvent() :: wx:wx_object().
-type wxSetCursorEventType() :: set_cursor.
Functions
-spec getCursor(This) -> wxCursor:wxCursor() when This :: wxSetCursorEvent().
Returns a reference to the cursor specified by this event.
-spec getX(This) -> integer() when This :: wxSetCursorEvent().
Returns the X coordinate of the mouse in client coordinates.
-spec getY(This) -> integer() when This :: wxSetCursorEvent().
Returns the Y coordinate of the mouse in client coordinates.
-spec hasCursor(This) -> boolean() when This :: wxSetCursorEvent().
Returns true if the cursor specified by this event is a valid cursor.
Remark: You cannot specify wxNullCursor with this event, as it is not considered a valid cursor.
-spec setCursor(This, Cursor) -> ok when This :: wxSetCursorEvent(), Cursor :: wxCursor:wxCursor().
Sets the cursor associated with this event.