*****************
wx.SetCursorEvent
*****************

Inheritance diagram for `wx.SetCursorEvent`:

|

.. inheritance-diagram:: wx.SetCursorEvent

|

Description
===========

A `wx.SetCursorEvent` is generated 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 <#SetCursor>`_ to specify the cursor you want to be displayed.


.. seealso:: `wx.SetCursor <../wxFunctions.html#SetCursor>`_ `wx.Window.SetCursor <../Widgets/wx.Window.html#SetCursor>`_



Derived From
^^^^^^^^^^^^^

* `wx.Event <wx.Event.html>`_ 
* `wx.Object <../Widgets/wx.Object.html>`_ 

Event Handling
^^^^^^^^^^^^^^

==================================================  ==================================================  
Event Name                                          Description
==================================================  ==================================================  
wx.EVT_SET_CURSOR(func)                             Process a ``wx.wxEVT_SET_CURSOR`` event.
==================================================  ==================================================  


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetCursor <#GetCursor>`_ 
* `GetX <#GetX>`_ 
* `GetY <#GetY>`_ 
* `HasCursor <#HasCursor>`_ 
* `SetCursor <#SetCursor>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `Cursor <#Cursor>`_ 
* `X <#X>`_ 
* `Y <#Y>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(x=0, y=0)

   Construct a new `wx.SetCursorEvent <wx.SetCursorEvent.html>`_.
   
   **Parameters:**

   * `x` (int)
   * `y` (int)

   |

   **Returns:**

   `wx.SetCursorEvent <wx.SetCursorEvent.html>`_
 

--------

.. method:: GetCursor()

   Returns a reference to the cursor specified by this event.

   |  

   **Returns:**

   `wx.Cursor <../Widgets/wx.Cursor.html>`_
 

--------

.. method:: GetX()

   Returns the `X` coordinate of the mouse in client coordinates.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetY()

   Returns the `Y` coordinate of the mouse in client coordinates.

   |  

   **Returns:**

   `int` 

--------

.. method:: HasCursor()

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

   |  

   **Returns:**

   `bool` 


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

--------

.. method:: SetCursor(cursor)

   Sets the cursor associated with this event.

   **Parameters:**

   * `cursor` (`wx.Cursor <../Widgets/wx.Cursor.html>`_)


--------

Properties
^^^^^^^^^^


.. attribute:: Cursor

   See `GetCursor <#GetCursor>`_ and `SetCursor <#SetCursor>`_

.. attribute:: X

   See `GetX <#GetX>`_

.. attribute:: Y

   See `GetY <#GetY>`_