<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year><year>2021</year>
    <holder>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxSetCursorEvent</title>
</header>
<module>wxSetCursorEvent</module>
<modulesummary>Functions for wxSetCursorEvent class</modulesummary>
<description><p>A <seeerl marker="wxSetCursorEvent"><c>wxSetCursorEvent</c></seeerl> is generated from <seeerl marker="wxWindow"><c>wxWindow</c></seeerl> when the mouse cursor is about to be set as a result of mouse motion.
      </p><p>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 <seemfa marker="#setCursor/2"><c>setCursor/2</c></seemfa> to specify the cursor you want to be displayed.
      </p><p>See: <seemfa marker="wx_misc#setCursor/1"><c>wx_misc:setCursor/1</c></seemfa>, <seemfa marker="wxWindow#setCursor/2"><c>wxWindow:setCursor/2</c></seemfa>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxEvent"><c>wxEvent</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_set_cursor_event.html">wxSetCursorEvent</url></p>
  </description><section><title>Events</title><p>Use <seemfa marker="wxEvtHandler#connect/3"><c>wxEvtHandler:connect/3</c></seemfa> with <seetype marker="#wxSetCursorEventType"><c>wxSetCursorEventType</c></seetype> to subscribe to events of this type.</p></section>
<datatypes>
    <datatype><name name="wxSetCursorEvent"/></datatype>
    <datatype><name name="wxSetCursor"/></datatype>
    <datatype><name name="wxSetCursorEventType"/></datatype></datatypes>

<funcs>
  <func>
    <name name="getCursor" arity="1" clause_i="1" since=""/>
    <fsummary>Returns a reference to the cursor specified by this event. </fsummary>
    <desc><p>Returns a reference to the cursor specified by this event. 
      </p></desc>
  </func>
  
  <func>
    <name name="getX" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the X coordinate of the mouse in client coordinates. </fsummary>
    <desc><p>Returns the X coordinate of the mouse in client coordinates. 
      </p></desc>
  </func>
  
  <func>
    <name name="getY" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the Y coordinate of the mouse in client coordinates. </fsummary>
    <desc><p>Returns the Y coordinate of the mouse in client coordinates. 
      </p></desc>
  </func>
  
  <func>
    <name name="hasCursor" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the cursor specified by this event is a valid cursor. </fsummary>
    <desc><p>Returns true if the cursor specified by this event is a valid cursor. 
      </p><p>Remark: You cannot specify wxNullCursor with this event, as it is not considered a valid cursor. 
      </p></desc>
  </func>
  
  <func>
    <name name="setCursor" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the cursor associated with this event. </fsummary>
    <desc><p>Sets the cursor associated with this event. 
      </p></desc>
  </func>
  </funcs>
</erlref>
