Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
CKey Class Reference

#include <Key.h>

Public Types

enum  Modifier {
  MODIFIER_CTRL = 0x00010000 , MODIFIER_SHIFT = 0x00020000 , MODIFIER_ALT = 0x00040000 , MODIFIER_RALT = 0x00080000 ,
  MODIFIER_SUPER = 0x00100000 , MODIFIER_META = 0X00200000 , MODIFIER_LONG = 0X01000000 , MODIFIER_NUMLOCK = 0X02000000 ,
  MODIFIER_CAPSLOCK = 0X04000000 , MODIFIER_SCROLLLOCK = 0X08000000
}
 

Public Member Functions

 CKey (void)
 
 CKey (uint32_t buttonCode, uint8_t leftTrigger=0, uint8_t rightTrigger=0, float leftThumbX=0.0f, float leftThumbY=0.0f, float rightThumbX=0.0f, float rightThumbY=0.0f, float repeat=0.0f)
 
 CKey (uint32_t buttonCode, unsigned int held)
 
 CKey (uint32_t keycode, uint8_t vkey, wchar_t unicode, char ascii, uint32_t modifiers, uint32_t lockingModifiers, unsigned int held)
 
 CKey (const CKey &key)
 
void Reset ()
 
virtual ~CKey (void)
 
CKeyoperator= (const CKey &key)
 
uint8_t GetLeftTrigger () const
 
uint8_t GetRightTrigger () const
 
float GetLeftThumbX () const
 
float GetLeftThumbY () const
 
float GetRightThumbX () const
 
float GetRightThumbY () const
 
float GetRepeat () const
 
bool FromKeyboard () const
 
bool IsAnalogButton () const
 
bool IsIRRemote () const
 
void SetFromService (bool fromService)
 
bool GetFromService () const
 
uint32_t GetButtonCode () const
 
uint32_t GetKeycode () const
 
uint8_t GetVKey () const
 
wchar_t GetUnicode () const
 
char GetAscii () const
 
uint32_t GetModifiers () const
 
uint32_t GetLockingModifiers () const
 
unsigned int GetHeld () const
 

Member Enumeration Documentation

◆ Modifier

Enumerator
MODIFIER_CTRL 
MODIFIER_SHIFT 
MODIFIER_ALT 
MODIFIER_RALT 
MODIFIER_SUPER 
MODIFIER_META 
MODIFIER_LONG 
MODIFIER_NUMLOCK 
MODIFIER_CAPSLOCK 
MODIFIER_SCROLLLOCK 

Constructor & Destructor Documentation

◆ CKey() [1/5]

CKey::CKey ( void )

◆ CKey() [2/5]

CKey::CKey ( uint32_t buttonCode,
uint8_t leftTrigger = 0,
uint8_t rightTrigger = 0,
float leftThumbX = 0.0f,
float leftThumbY = 0.0f,
float rightThumbX = 0.0f,
float rightThumbY = 0.0f,
float repeat = 0.0f )

◆ CKey() [3/5]

CKey::CKey ( uint32_t buttonCode,
unsigned int held )

◆ CKey() [4/5]

CKey::CKey ( uint32_t keycode,
uint8_t vkey,
wchar_t unicode,
char ascii,
uint32_t modifiers,
uint32_t lockingModifiers,
unsigned int held )

◆ CKey() [5/5]

CKey::CKey ( const CKey & key)

◆ ~CKey()

CKey::~CKey ( void )
virtualdefault

Member Function Documentation

◆ FromKeyboard()

bool CKey::FromKeyboard ( ) const

◆ GetAscii()

char CKey::GetAscii ( ) const
inline

◆ GetButtonCode()

uint32_t CKey::GetButtonCode ( ) const
inline

◆ GetFromService()

bool CKey::GetFromService ( ) const
inline

◆ GetHeld()

unsigned int CKey::GetHeld ( ) const
inline

◆ GetKeycode()

uint32_t CKey::GetKeycode ( ) const
inline

◆ GetLeftThumbX()

float CKey::GetLeftThumbX ( ) const

◆ GetLeftThumbY()

float CKey::GetLeftThumbY ( ) const

◆ GetLeftTrigger()

uint8_t CKey::GetLeftTrigger ( ) const

◆ GetLockingModifiers()

uint32_t CKey::GetLockingModifiers ( ) const
inline

◆ GetModifiers()

uint32_t CKey::GetModifiers ( ) const
inline

◆ GetRepeat()

float CKey::GetRepeat ( ) const

◆ GetRightThumbX()

float CKey::GetRightThumbX ( ) const

◆ GetRightThumbY()

float CKey::GetRightThumbY ( ) const

◆ GetRightTrigger()

uint8_t CKey::GetRightTrigger ( ) const

◆ GetUnicode()

wchar_t CKey::GetUnicode ( ) const
inline

◆ GetVKey()

uint8_t CKey::GetVKey ( ) const
inline

◆ IsAnalogButton()

bool CKey::IsAnalogButton ( ) const

◆ IsIRRemote()

bool CKey::IsIRRemote ( ) const

◆ operator=()

CKey & CKey::operator= ( const CKey & key)

◆ Reset()

void CKey::Reset ( )

◆ SetFromService()

void CKey::SetFromService ( bool fromService)

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