wx.SetCursorEvent

A wx.SetCursorEvent is generated from wx.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 wx.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 wx.SetCursorEvent parameter.

• EVT_SET_CURSOR: Process a wxEVT_SET_CURSOR event.

See also

wx.SetCursor , wx.Window.SetCursor

Class Hierarchy

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.
GetPosition	Returns the mouse position for which the cursor is requested.
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 wx.SetCursorEvent(Event)

Possible constructors:

SetCursorEvent(x=0, y=0) -> None

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

Methods

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

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

Parameters:

• x (int)

• y (int)

Return type:

None

---

GetCursor(self)

Returns a reference to the cursor specified by this event.

Return type:

wx.Cursor

---

GetPosition(self)

Returns the mouse position for which the cursor is requested.

This position is expressed in the client coordinates of the window.

Return type:

wx.Point

Added in version 4.3/wxWidgets-3.3.0.

See also

GetX , GetY

---

GetX(self)

Returns the X coordinate of the mouse in client coordinates.

Return type:

int

See also

GetPosition

---

GetY(self)

Returns the Y coordinate of the mouse in client coordinates.

Return type:

int

See also

GetPosition

---

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 (wx.Cursor)

Return type:

None

Properties

Cursor

See GetCursor and SetCursor

---

X

See GetX

---

Y

See GetY