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.
15 #include "support/std_string.h"
18 * This is a base class for representing a keypress.
19 * Each frontend has to implement this to provide
20 * the functionality that LyX needs in regards to
27 virtual ~LyXKeySym() {}
29 /// Initialize with the name of a key. F. ex. "space" or "a"
30 virtual void init(string const & symbolname) = 0;
32 /// Is this a valid key?
33 virtual bool isOK() const = 0;
35 /// Is this a modifier key only?
36 virtual bool isModifier() const = 0;
38 /// Is this normal insertable text ? (last ditch attempt only)
39 virtual bool isText() const { return false; }
41 /// What is the symbolic name of this key? F.ex. "Return" or "c"
42 virtual string getSymbolName() const = 0;
45 * Return the value of the keysym into the local ISO encoding.
46 * This converts the LyXKeySym to a 8-bit encoded character.
47 * This relies on user to use the right encoding.
49 virtual char getISOEncoded(string const & encoding) const = 0;
54 * We need to be able to equality compare these for the
55 * sake of the keymap business.
57 bool operator==(LyXKeySym const & k1, LyXKeySym const & k2);