Kodi Documentation  18.0
Kodi is an open source media player and entertainment hub.
Public Member Functions | Static Public Member Functions | List of all members
kodi::addon::Joystick Class Reference

#include <PeripheralUtils.h>

Inheritance diagram for kodi::addon::Joystick:
kodi::addon::Peripheral

Public Member Functions

 Joystick (const std::string &provider="", const std::string &strName="")
 
 Joystick (const Joystick &other)
 
 Joystick (const JOYSTICK_INFO &info)
 
 ~Joystick (void) override=default
 
Joystick & operator= (const Joystick &rhs)
 
const std::string & Provider (void) const
 
int RequestedPort (void) const
 
unsigned int ButtonCount (void) const
 
unsigned int HatCount (void) const
 
unsigned int AxisCount (void) const
 
unsigned int MotorCount (void) const
 
bool SupportsPowerOff (void) const
 
void SetProvider (const std::string &provider)
 
void SetRequestedPort (int requestedPort)
 
void SetButtonCount (unsigned int buttonCount)
 
void SetHatCount (unsigned int hatCount)
 
void SetAxisCount (unsigned int axisCount)
 
void SetMotorCount (unsigned int motorCount)
 
void SetSupportsPowerOff (bool supportsPowerOff)
 
void ToStruct (JOYSTICK_INFO &info) const
 
- Public Member Functions inherited from kodi::addon::Peripheral
 Peripheral (PERIPHERAL_TYPE type=PERIPHERAL_TYPE_UNKNOWN, const std::string &strName="")
 
 Peripheral (const PERIPHERAL_INFO &info)
 
virtual ~Peripheral (void)=default
 
PERIPHERAL_TYPE Type (void) const
 
const std::string & Name (void) const
 
uint16_t VendorID (void) const
 
uint16_t ProductID (void) const
 
unsigned int Index (void) const
 
bool IsVidPidKnown (void) const
 
void SetType (PERIPHERAL_TYPE type)
 
void SetName (const std::string &strName)
 
void SetVendorID (uint16_t vendorId)
 
void SetProductID (uint16_t productId)
 
void SetIndex (unsigned int index)
 
void ToStruct (PERIPHERAL_INFO &info) const
 

Static Public Member Functions

static void FreeStruct (JOYSTICK_INFO &info)
 
- Static Public Member Functions inherited from kodi::addon::Peripheral
static void FreeStruct (PERIPHERAL_INFO &info)
 

Detailed Description

kodi::addon::Joystick

Wrapper class providing additional joystick information not provided by ADDON::Peripheral.

Constructor & Destructor Documentation

§ Joystick() [1/3]

kodi::addon::Joystick::Joystick ( const std::string &  provider = "",
const std::string &  strName = "" 
)
inline

§ Joystick() [2/3]

kodi::addon::Joystick::Joystick ( const Joystick &  other)
inline

§ Joystick() [3/3]

kodi::addon::Joystick::Joystick ( const JOYSTICK_INFO &  info)
inlineexplicit

§ ~Joystick()

kodi::addon::Joystick::~Joystick ( void  )
overridedefault

Member Function Documentation

§ AxisCount()

unsigned int kodi::addon::Joystick::AxisCount ( void  ) const
inline

§ ButtonCount()

unsigned int kodi::addon::Joystick::ButtonCount ( void  ) const
inline

§ FreeStruct()

static void kodi::addon::Joystick::FreeStruct ( JOYSTICK_INFO &  info)
inlinestatic

§ HatCount()

unsigned int kodi::addon::Joystick::HatCount ( void  ) const
inline

§ MotorCount()

unsigned int kodi::addon::Joystick::MotorCount ( void  ) const
inline

§ operator=()

Joystick& kodi::addon::Joystick::operator= ( const Joystick &  rhs)
inline

§ Provider()

const std::string& kodi::addon::Joystick::Provider ( void  ) const
inline

§ RequestedPort()

int kodi::addon::Joystick::RequestedPort ( void  ) const
inline

§ SetAxisCount()

void kodi::addon::Joystick::SetAxisCount ( unsigned int  axisCount)
inline

§ SetButtonCount()

void kodi::addon::Joystick::SetButtonCount ( unsigned int  buttonCount)
inline

§ SetHatCount()

void kodi::addon::Joystick::SetHatCount ( unsigned int  hatCount)
inline

§ SetMotorCount()

void kodi::addon::Joystick::SetMotorCount ( unsigned int  motorCount)
inline

§ SetProvider()

void kodi::addon::Joystick::SetProvider ( const std::string &  provider)
inline

§ SetRequestedPort()

void kodi::addon::Joystick::SetRequestedPort ( int  requestedPort)
inline

§ SetSupportsPowerOff()

void kodi::addon::Joystick::SetSupportsPowerOff ( bool  supportsPowerOff)
inline

§ SupportsPowerOff()

bool kodi::addon::Joystick::SupportsPowerOff ( void  ) const
inline

§ ToStruct()

void kodi::addon::Joystick::ToStruct ( JOYSTICK_INFO &  info) const
inline
The documentation for this class was generated from the following file: