xbmc/input/KeyboardStat.h

   1 #ifndef _KEYBOARD_H
   2 #define _KEYBOARD_H
   3
   4 #pragma once
   5
   6 /*
   7  *      Copyright (C) 2007-2013 Team XBMC
   8  *      http://xbmc.org
   9  *
  10  *  This Program is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License as published by
  12  *  the Free Software Foundation; either version 2, or (at your option)
  13  *  any later version.
  14  *
  15  *  This Program is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License
  21  *  along with XBMC; see the file COPYING.  If not, see
  22  *  <http://www.gnu.org/licenses/>.
  23  *
  24  */
  25
  26 //
  27 // C++ Interface: CKeyboard
  28 //
  29 // Description: Adds features like international keyboard layout mapping on top of the
  30 // platform specific low level keyboard classes.
  31 // Here it must be done only once. Within the other mentioned classes it would have to be done several times.
  32 //
  33 // Keyboards alyways deliver printable characters, logical keys for functional behaviour, modifiers ... alongside
  34 // Based on the same hardware with the same scancodes (also alongside) but delivered with different labels to customers
  35 // the software must solve the mapping to the real labels. This is done here.
  36 // The mapping must be specified by an xml configuration that should be able to access everything available,
  37 // but this allows for double/redundant or ambiguous mapping definition, e.g.
  38 // ASCII/unicode could be derived from scancodes, virtual keys, modifiers and/or other ASCII/unicode.
  39
  40 #include "windowing/XBMC_events.h"
  41 #include "guilib/Key.h"
  42
  43 class CKeyboardStat
  44 {
  45 public:
  46   CKeyboardStat();
  47   ~CKeyboardStat();
  48
  49   void Initialize();
  50
  51   const CKey ProcessKeyDown(XBMC_keysym& keysym);
  52   void       ProcessKeyUp(void);
  53
  54   CStdString GetKeyName(int KeyID);
  55
  56 private:
  57   bool LookupSymAndUnicodePeripherals(XBMC_keysym &keysym, uint8_t *key, char *unicode);
  58
  59   XBMC_keysym m_lastKeysym;
  60   unsigned int m_lastKeyTime;
  61 };
  62
  63 extern CKeyboardStat g_Keyboard;
  64
  65 #endif