src/frontends/LyXKeySym.h

   1 // -*- C++ -*-
   2 /**
   3  * \file LyXKeySym.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Asger and Jürgen
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef LYXKEYSYM_H
  13 #define LYXKEYSYM_H
  14
  15 #include <string>
  16
  17 #include "key_state.h"
  18
  19 #include "support/docstring.h"
  20
  21 #include <boost/shared_ptr.hpp>
  22
  23
  24 namespace lyx {
  25
  26 /**
  27  * This is a base class for representing a keypress.
  28  * Each frontend has to implement this to provide
  29  * the functionality that LyX needs in regards to
  30  * key presses.
  31  */
  32 class LyXKeySym {
  33 public:
  34         LyXKeySym() {}
  35
  36         virtual ~LyXKeySym() {}
  37
  38         /// Initialize with the name of a key. F. ex. "space" or "a"
  39         virtual void init(std::string const & symbolname) = 0;
  40
  41         /// Is this a valid key?
  42         virtual bool isOK() const = 0;
  43
  44         /// Is this a modifier key only?
  45         virtual bool isModifier() const = 0;
  46
  47         /// Is this normal insertable text ? (last ditch attempt only)
  48         virtual bool isText() const = 0;
  49
  50         /// What is the symbolic name of this key? F.ex. "Return" or "c"
  51         virtual std::string getSymbolName() const = 0;
  52
  53         /**
  54          * Return the value of the keysym into the UCS-4 encoding.
  55          * This converts the LyXKeySym to a 32-bit encoded character.
  56          */
  57         virtual size_t getUCSEncoded() const = 0;
  58
  59         /**
  60          * Return a string describing the KeySym with modifier mod.
  61          * This should use the native UI format when applicable
  62          */
  63         virtual docstring const print(key_modifier::state mod) const = 0;
  64 };
  65
  66
  67 /**
  68  * We need to be able to equality compare these for the
  69  * sake of the keymap business.
  70  */
  71 bool operator==(LyXKeySym const & k1, LyXKeySym const & k2);
  72
  73 typedef boost::shared_ptr<LyXKeySym> LyXKeySymPtr;
  74
  75
  76 } // namespace lyx
  77
  78 #endif