ktouch/src/ktouchkeyconnector.h

   1 /***************************************************************************
   2  *   ktouchkeyconnetor.h                                                   *
   3  *   -------------------                                                   *
   4  *   Copyright (C) 2000 by Håvard Frøiland, 2003 by Andreas Nicolai        *
   5  *   haavard@users.sourceforge.net                                         *
   6  *                                                                         *
   7  *   This program is free software; you can redistribute it and/or modify  *
   8  *   it under the terms of the GNU General Public License as published by  *
   9  *   the Free Software Foundation; either version 2 of the License, or     *
  10  *   (at your option) any later version.                                   *
  11  ***************************************************************************/
  12
  13 #ifndef KTOUCHKEYCONNECTOR_H
  14 #define KTOUCHKEYCONNECTOR_H
  15
  16
  17 #include "ktouchkeys.h"
  18
  19  /// This is the key connector which represents a key or key combination that can be pressed.
  20  /// It associates a character with a target key and optionally a finger and/or control key.
  21 class KTouchKeyConnector {
  22   public:
  23     /// Default constructor
  24     KTouchKeyConnector() : m_keyChar(0), m_targetKeyChar(0), m_fingerKeyChar(0), m_controlKeyChar(0) {};
  25     /// Constructor provided for convenience.
  26     KTouchKeyConnector(const QChar& keyChar, const QChar& targetKeyChar, const QChar& fingerKeyChar,
  27                        const QChar& controlKeyChar)
  28       : m_keyChar(keyChar), m_targetKeyChar(targetKeyChar), m_fingerKeyChar(fingerKeyChar), m_controlKeyChar(controlKeyChar) {};
  29
  30     /// This is the character that has to be pressed to access this key.
  31     QChar               m_keyChar;
  32
  33     QChar               m_targetKeyChar;    ///< The target character (the key the user has to press).
  34     QChar               m_fingerKeyChar;    ///< The finger key (where the used finger normally rests).
  35     QChar               m_controlKeyChar;   ///< The modifier key the user has to press also (for example LeftShift).
  36 };
  37
  38 #endif  // KTOUCHKEYCONNECTOR_H