4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Asger and Jürgen
9 * Full author contact details are available in file CREDITS.
17 #include "key_state.h"
19 #include <boost/shared_ptr.hpp>
25 * This is a base class for representing a keypress.
26 * Each frontend has to implement this to provide
27 * the functionality that LyX needs in regards to
34 virtual ~LyXKeySym() {}
36 /// Initialize with the name of a key. F. ex. "space" or "a"
37 virtual void init(std::string const & symbolname) = 0;
39 /// Is this a valid key?
40 virtual bool isOK() const = 0;
42 /// Is this a modifier key only?
43 virtual bool isModifier() const = 0;
45 /// Is this normal insertable text ? (last ditch attempt only)
46 virtual bool isText() const = 0;
48 /// What is the symbolic name of this key? F.ex. "Return" or "c"
49 virtual std::string getSymbolName() const = 0;
52 * Return the value of the keysym into the UCS-4 encoding.
53 * This converts the LyXKeySym to a 32-bit encoded character.
55 virtual size_t getUCSEncoded() const = 0;
58 * Return a string describing the KeySym with modifier mod.
59 * This should use the native UI format when applicable
61 virtual std::string const print(key_modifier::state mod) const = 0;
66 * We need to be able to equality compare these for the
67 * sake of the keymap business.
69 bool operator==(LyXKeySym const & k1, LyXKeySym const & k2);
71 typedef boost::shared_ptr<LyXKeySym> LyXKeySymPtr;