include/wx/msw/joystick.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        joystick.h
   3 // Purpose:     wxJoystick class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_JOYSTICK_H_
  13 #define _WX_JOYSTICK_H_
  14
  15 #ifdef __GNUG__
  16 #pragma interface "joystick.h"
  17 #endif
  18
  19 #include "wx/event.h"
  20
  21 class WXDLLEXPORT wxJoystick: public wxObject
  22 {
  23   DECLARE_DYNAMIC_CLASS(wxJoystick)
  24  public:
  25   /*
  26    * Public interface
  27    */
  28
  29   wxJoystick(int joystick = wxJOYSTICK1);
  30
  31   // Attributes
  32   ////////////////////////////////////////////////////////////////////////////
  33
  34   wxPoint GetPosition(void) const;
  35   int GetZPosition(void) const;
  36   int GetButtonState(void) const;
  37   int GetPOVPosition(void) const;
  38   int GetPOVCTSPosition(void) const;
  39   int GetRudderPosition(void) const;
  40   int GetUPosition(void) const;
  41   int GetVPosition(void) const;
  42   int GetMovementThreshold(void) const;
  43   void SetMovementThreshold(int threshold) ;
  44
  45   // Capabilities
  46   ////////////////////////////////////////////////////////////////////////////
  47
  48   static int GetNumberJoysticks(void);
  49
  50   bool IsOk(void) const; // Checks that the joystick is functioning
  51   int GetManufacturerId(void) const ;
  52   int GetProductId(void) const ;
  53   wxString GetProductName(void) const ;
  54   int GetXMin(void) const;
  55   int GetYMin(void) const;
  56   int GetZMin(void) const;
  57   int GetXMax(void) const;
  58   int GetYMax(void) const;
  59   int GetZMax(void) const;
  60   int GetNumberButtons(void) const;
  61   int GetNumberAxes(void) const;
  62   int GetMaxButtons(void) const;
  63   int GetMaxAxes(void) const;
  64   int GetPollingMin(void) const;
  65   int GetPollingMax(void) const;
  66   int GetRudderMin(void) const;
  67   int GetRudderMax(void) const;
  68   int GetUMin(void) const;
  69   int GetUMax(void) const;
  70   int GetVMin(void) const;
  71   int GetVMax(void) const;
  72
  73   bool HasRudder(void) const;
  74   bool HasZ(void) const;
  75   bool HasU(void) const;
  76   bool HasV(void) const;
  77   bool HasPOV(void) const;
  78   bool HasPOV4Dir(void) const;
  79   bool HasPOVCTS(void) const;
  80
  81   // Operations
  82   ////////////////////////////////////////////////////////////////////////////
  83
  84   // pollingFreq = 0 means that movement events are sent when above the threshold.
  85   // If pollingFreq > 0, events are received every this many milliseconds.
  86   bool SetCapture(wxWindow* win, int pollingFreq = 0);
  87   bool ReleaseCapture(void);
  88
  89 protected:
  90   int       m_joystick;
  91 };
  92
  93 #endif
  94     // _WX_JOYSTICK_H_