<?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>
    <holder>Ericsson AB. All Rights Reserved.</holder></copyright>
  <legalnotice>
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

  </legalnotice>
  <title>wxJoystickEvent</title>
</header>
<module>wxJoystickEvent</module>
<modulesummary>Functions for wxJoystickEvent class</modulesummary>
<description><p>This event class contains information about joystick events, particularly events received by windows.
      </p><p>See: <c>wxJoystick</c> (not implemented in wx)
      </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_joystick_event.html">wxJoystickEvent</url></p>
  </description><section><title>Events</title><p>Use <seemfa marker="wxEvtHandler#connect/3"><c>wxEvtHandler:connect/3</c></seemfa> with <seetype marker="#wxJoystickEventType"><c>wxJoystickEventType</c></seetype> to subscribe to events of this type.</p></section>
<datatypes>
    <datatype><name name="wxJoystickEvent"/></datatype>
    <datatype><name name="wxJoystick"/></datatype>
    <datatype><name name="wxJoystickEventType"/></datatype></datatypes>

<funcs>
  <func>
    <name name="buttonDown" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>buttonDown/2</c></fsummary>
  </func>
  
  <func>
    <name name="buttonDown" arity="2" clause_i="1" since=""/>
    <fsummary>Returns true if the event was a down event from the specified button (or any button). </fsummary>
    <desc><p>Returns true if the event was a down event from the specified button (or any button). 
      </p></desc>
  </func>
  
  <func>
    <name name="buttonIsDown" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>buttonIsDown/2</c></fsummary>
  </func>
  
  <func>
    <name name="buttonIsDown" arity="2" clause_i="1" since=""/>
    <fsummary>Returns true if the specified button (or any button) was in a down state. </fsummary>
    <desc><p>Returns true if the specified button (or any button) was in a down state. 
      </p></desc>
  </func>
  
  <func>
    <name name="buttonUp" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>buttonUp/2</c></fsummary>
  </func>
  
  <func>
    <name name="buttonUp" arity="2" clause_i="1" since=""/>
    <fsummary>Returns true if the event was an up event from the specified button (or any button). </fsummary>
    <desc><p>Returns true if the event was an up event from the specified button (or any button). 
      </p></desc>
  </func>
  
  <func>
    <name name="getButtonChange" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the identifier of the button changing state. </fsummary>
    <desc><p>Returns the identifier of the button changing state. 
      </p><p>The return value is where <c>n</c> is the index of the button changing state, which can also be retrieved using <c>GetButtonOrdinal()</c> (not implemented in wx).
      </p><p>Note that for <c>n</c> equal to 1, 2, 3 or 4 there are predefined <c>wxJOY_BUTTONn</c> constants which can be used for more clarity, however these constants are not defined for the buttons beyond the first four. 
      </p></desc>
  </func>
  
  <func>
    <name name="getButtonState" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the down state of the buttons. </fsummary>
    <desc><p>Returns the down state of the buttons. 
      </p><p>This is a <c>wxJOY_BUTTONn</c> identifier, where <c>n</c> is one of 1, 2, 3, 4. 
      </p></desc>
  </func>
  
  <func>
    <name name="getJoystick" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the identifier of the joystick generating the event - one of wxJOYSTICK1 and wxJOYSTICK2. </fsummary>
    <desc><p>Returns the identifier of the joystick generating the event - one of wxJOYSTICK1 and wxJOYSTICK2. 
      </p></desc>
  </func>
  
  <func>
    <name name="getPosition" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the x, y position of the joystick event. </fsummary>
    <desc><p>Returns the x, y position of the joystick event. 
      </p><p>These coordinates are valid for all the events except wxEVT_JOY_ZMOVE. 
      </p></desc>
  </func>
  
  <func>
    <name name="getZPosition" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the z position of the joystick event. </fsummary>
    <desc><p>Returns the z position of the joystick event. 
      </p><p>This method can only be used for wxEVT_JOY_ZMOVE events. 
      </p></desc>
  </func>
  
  <func>
    <name name="isButton" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if this was a button up or down event (<c>not</c> 'is any button down?'). </fsummary>
    <desc><p>Returns true if this was a button up or down event (<c>not</c> 'is any button down?'). 
      </p></desc>
  </func>
  
  <func>
    <name name="isMove" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if this was an x, y move event. </fsummary>
    <desc><p>Returns true if this was an x, y move event. 
      </p></desc>
  </func>
  
  <func>
    <name name="isZMove" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if this was a z move event. </fsummary>
    <desc><p>Returns true if this was a z move event. 
      </p></desc>
  </func>
  </funcs>
</erlref>
