wxSetCursorEvent (wx v2.5.4)

Copy Markdown View Source

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:

This class is derived, and can use functions, from:

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

wxSetCursor()

-type wxSetCursor() ::
          #wxSetCursor{type :: wxSetCursorEvent:wxSetCursorEventType(),
                       x :: integer(),
                       y :: integer(),
                       cursor :: wxCursor:wxCursor()}.

wxSetCursorEvent()

-type wxSetCursorEvent() :: wx:wx_object().

wxSetCursorEventType()

-type wxSetCursorEventType() :: set_cursor.

Functions

getCursor(This :: wxSetCursorEvent()) -> wxCursor:wxCursor()

Returns a reference to the cursor specified by this event.

getX(This :: wxSetCursorEvent()) -> integer()

Returns the X coordinate of the mouse in client coordinates.

getY(This :: wxSetCursorEvent()) -> integer()

Returns the Y coordinate of the mouse in client coordinates.

hasCursor(This :: wxSetCursorEvent()) -> boolean()

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.

setCursor(This :: wxSetCursorEvent(), Cursor :: wxCursor:wxCursor()) -> ok

Sets the cursor associated with this event.