SetCursorEvent

A SetCursorEvent is generated from Window 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 SetCursorEvent.SetCursor to specify the cursor you want to be displayed.

Events Emitted by this Class

Handlers bound for the following event types will receive a SetCursorEvent parameter.

• EVT_SET_CURSOR: Process a wxEVT_SET_CURSOR event.

See also

SetCursor, Window.wxSetCursor

Inheritance Diagram

Inheritance diagram for class SetCursorEvent

Methods Summary

__init__	Constructor, used by the library itself internally to initialize the event object.
GetCursor	Returns a reference to the cursor specified by this event.
GetX	Returns the X coordinate of the mouse in client coordinates.
GetY	Returns the Y coordinate of the mouse in client coordinates.
HasCursor	Returns True if the cursor specified by this event is a valid cursor.
SetCursor	Sets the cursor associated with this event.

Properties Summary

Cursor	See GetCursor and SetCursor
X	See GetX
Y	See GetY

Class API

---

class SetCursorEvent(Event)

A SetCursorEvent is generated from Window when the mouse cursor is about to be set as a result of mouse motion.

Possible constructors:

SetCursorEvent(x=0, y=0)

Methods

---

__init__(self, x=0, y=0)

Constructor, used by the library itself internally to initialize the event object.

Parameters:

• x (int) –
• y (int) –

---

GetCursor(self)

Returns a reference to the cursor specified by this event.

Return type: Cursor

---

GetX(self)

Returns the X coordinate of the mouse in client coordinates.

Return type:int

---

GetY(self)

Returns the Y coordinate of the mouse in client coordinates.

Return type:int

---

HasCursor(self)

Returns True if the cursor specified by this event is a valid cursor.

Return type:bool

Note

You cannot specify NullCursor with this event, as it is not considered a valid cursor.

---

SetCursor(self, cursor)

Sets the cursor associated with this event.

Parameters:cursor (Cursor) –

Properties

---

Cursor

See GetCursor and SetCursor

---

X

See GetX

---

Y

See GetY