clan::InputDeviceProvider Class Referenceabstract

Interface for implementing a InputDevice source. More...

#include <input_device_provider.h>

+ Inheritance diagram for clan::InputDeviceProvider:

Public Member Functions

void dispose ()
 
bool is_disposed () const
 
void throw_if_disposed () const
 
Construction
virtual ~InputDeviceProvider ()
 
Attributes
virtual std::string get_name () const =0
 Returns the human readable name of the device (i.e. 'Microsoft Sidewinder 3D'). More...
 
virtual std::string get_device_name () const =0
 Return the hardware id/device for this device (i.e. /dev/input/js0) More...
 
virtual InputDevice::Type get_type () const =0
 Returns the input device type. More...
 
virtual std::string get_key_name (int id) const =0
 Friendly key name for specified identifier (A, B, Leertaste, Backspace, Mouse Left, ...). More...
 
virtual bool supports_keyid_mapping () const
 Returns true if this provider implements keyid to/from string mapping. More...
 
virtual std::string keyid_to_string (int) const
 Returns a generic string name for the specified key code. More...
 
virtual int string_to_keyid (const std::string &) const
 Returns the key code for the specified generic string key name. More...
 
virtual bool get_keycode (int keycode) const =0
 Returns true if the passed key code is down for this device. More...
 
virtual int get_x () const =0
 Returns the x position of the device. More...
 
virtual int get_y () const =0
 Returns the y position of the device. More...
 
virtual float get_axis (int index) const =0
 Returns the the current position of a joystick axis. More...
 
virtual std::vector< int > get_axis_ids () const =0
 Returns the number of axes available on this device. More...
 
virtual int get_hat (int) const
 Returns the current position of a joystick hat. More...
 
virtual int get_button_count () const =0
 Returns the number of buttons available on this device. More...
 
virtual bool in_proximity () const =0
 Returns the input device is in proximity mode. (Atm applicapble only to tablet.) More...
 
Operations
virtual void init (Signal_v1< const InputEvent & > *sig_provider_event)=0
 Initialize input device provider. More...
 
virtual void set_position (int x, int y)=0
 Sets the position of the device. More...
 

Protected Member Functions

virtual void on_dispose ()=0
 

Detailed Description

Interface for implementing a InputDevice source.

Member Function Documentation

void clan::DisposableObject::dispose ( )
inherited
bool clan::DisposableObject::is_disposed ( ) const
inherited
virtual void clan::DisposableObject::on_dispose ( )
protectedpure virtualinherited
void clan::DisposableObject::throw_if_disposed ( ) const
inherited

The documentation for this class was generated from the following file: