.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2020 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.SetCursorEvent:

==========================================================================================================================================
|phoenix_title|  **wx.SetCursorEvent**
==========================================================================================================================================

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







.. _SetCursorEvent-events:

|events| Events Emitted by this Class
=====================================

Handlers bound for the following event types will receive a :ref:`wx.SetCursorEvent` parameter.

 

- EVT_SET_CURSOR: Process a  ``wxEVT_SET_CURSOR``   event.   









         



.. seealso:: `wx.SetCursor`     , :meth:`wx.Window.SetCursor`     







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>SetCursorEvent</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.SetCursorEvent_inheritance.svg" alt="Inheritance diagram of SetCursorEvent" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.SetCursorEvent.html" title="A wx.SetCursorEvent  is generated from wx.Window  when the mouse cursor is about to be set as a result of mouse motion." alt="" coords="5,159,171,188"/> <area shape="rect" id="node2" href="wx.Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="41,82,135,111"/> <area shape="rect" id="node3" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="39,5,138,34"/> </map> 
   </p>
   </div>

|


|method_summary| Methods Summary
================================

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


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.SetCursorEvent.Cursor`                                                See :meth:`~wx.SetCursorEvent.GetCursor` and :meth:`~wx.SetCursorEvent.SetCursor`
:attr:`~wx.SetCursorEvent.X`                                                     See :meth:`~wx.SetCursorEvent.GetX`
:attr:`~wx.SetCursorEvent.Y`                                                     See :meth:`~wx.SetCursorEvent.GetY`
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.SetCursorEvent(Event)

   **Possible constructors**::

       SetCursorEvent(x: int=0, y: int=0) -> None
       
   
   A SetCursorEvent is generated from Window when the mouse cursor is
   about to be set as a result of mouse motion.



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

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


      :param `x`: 
      :type `x`: int
      :param `y`: 
      :type `y`: int




      :rtype: `None`     








   .. method:: GetCursor(self)

      Returns a reference to the cursor specified by this event. 
                 

      :rtype: :ref:`wx.Cursor`








   .. method:: GetX(self)

      Returns the X coordinate of the mouse in client coordinates. 
                 

      :rtype: `int`








   .. method:: GetY(self)

      Returns the Y coordinate of the mouse in client coordinates. 
                 

      :rtype: `int`








   .. method:: HasCursor(self)

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


                

      :rtype: `bool`







      .. note:: 

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








   .. method:: SetCursor(self, cursor : Cursor)

      Sets the cursor associated with this event. 
                 


      :param `cursor`: 
      :type `cursor`: wx.Cursor




      :rtype: `None`     








   .. attribute:: Cursor

      See :meth:`~wx.SetCursorEvent.GetCursor` and :meth:`~wx.SetCursorEvent.SetCursor`


   .. attribute:: X

      See :meth:`~wx.SetCursorEvent.GetX`


   .. attribute:: Y

      See :meth:`~wx.SetCursorEvent.GetY`