.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxJoystickEvent 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxJoystickEvent \- 
  A joystick event
 
.SH DESCRIPTION

  


   This event class contains information about mouse events, particularly events
   received by windows.
  
 
.SH "PARENTS"

  wxEvent
 
.SH "INCLUDE FILES"
wx/event.h
.SH MEMBERS

  
.SS  wxJoystickEvent (WXTYPE eventType = 0int state = 0int joystick = wxJOYSTICK1int change = 0)

     


      Constructor.
     
    
   
  
.SS bool ButtonDown (int button = wxJOY_BUTTON_ANY)

     


      Returns true if the event was a down event from the specified button (or
      any button).
     
    
   
  
.SS bool ButtonIsDown (int button = wxJOY_BUTTON_ANY)

     


      Returns true if the specified button (or any button) was in a down state.
     
    
   
  
.SS bool ButtonUp (int button = wxJOY_BUTTON_ANY)

     


      Returns true if the event was an up event from the specified button (or
      any button).
     
    
   
  
.SS int GetButtonChange ()

     


      Returns the identifier of the button changing state. This is a
      wxJOY_BUTTONn identifier, where n is one of 1, 2, 3, 4.
     
    
   
  
.SS int GetButtonState ()

     


      Returns the down state of the buttons. This is a bitlist of wxJOY_BUTTONn
      identifiers, where n is one of 1, 2, 3, 4.
     
    
   
  
.SS int GetJoystick ()

     


      Returns the identifier of the joystick generating the event - one of
      wxJOYSTICK1 and wxJOYSTICK2.
     
    
   
  
.SS wxPoint GetPosition ()

     


      Returns the x, y position of the joystick event.
     
    
   
  
.SS int GetZPosition ()

     


      Returns the z position of the joystick event.
     
    
   
  
.SS bool IsButton ()

     


      Returns true if this was a button up or down event (
      
       not
      
      'is any button down?').
     
    
   
  
.SS bool IsMove ()

     


      Returns true if this was an x, y move event.
     
    
   
  
.SS bool IsZMove ()

     


      Returns true if this was a z move event.
     
    
 
.SH EVENTS

.SS EVT_JOY_BUTTON_DOWN(func)

   Process a wxEVT_JOY_BUTTON_DOWN event.
  
.SS EVT_JOY_BUTTON_UP(func)

   Process a wxEVT_JOY_BUTTON_UP event.
  
.SS EVT_JOY_MOVE(func)

   Process a wxEVT_JOY_MOVE event.
  
.SS EVT_JOY_ZMOVE(func)

   Process a wxEVT_JOY_ZMOVE event.
  
.SS EVT_JOYSTICK_EVENTS(func)

   Processes all joystick events.
  
.SH "SEE ALSO"

  wxEvent
 
  wxJoystick
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.