lyx_mirror/src/frontends/qt4/QKeySymbol.h
André Pönitz 50016ccf3a rename LyXKeySym into KeySymbol
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@18059 a592a061-630c-0410-9148-cb99ea01b6c8
2007-04-27 08:43:38 +00:00

88 lines
1.7 KiB
C++

// -*- C++ -*-
/**
* \file QKeySymbol.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Asger and Jürgen
* \author John Levon
*
* Full author contact details are available in file CREDITS.
*/
#ifndef QLYXKEYSYM_H
#define QLYXKEYSYM_H
#include "frontends/KeySymbol.h"
#include <QString>
#include <QKeyEvent>
class QKeyEvent;
namespace lyx {
/**
* Qt-specific key press.
*
* This is some really sick stuff.
*/
class QKeySymbol : public KeySymbol {
public:
QKeySymbol();
virtual ~QKeySymbol() {}
/// .
/// inlined out because of profiling results under linux when
/// opening a document.
inline bool operator==(KeySymbol const& ks) const;
/// delayed constructor
void set(QKeyEvent * ev);
/// set from a LyX symbolic name
virtual void init(std::string const & symbolname);
/// Is this a valid key?
virtual bool isOK() const;
/// Is this a modifier key only?
virtual bool isModifier() const;
/// return the LyX symbolic name
virtual std::string getSymbolName() const;
/// Is this normal insertable text ? (last ditch attempt only)
virtual bool isText() const;
/**
* Return the value of the keysym into the UCS-4 encoding.
* This converts the KeySymbol to a 32-bit encoded character.
*/
virtual char_type getUCSEncoded() const;
/**
* Return a human-readable version of a key+modifier pair.
* This will be the GUI version (translated and with special
* characters for Mac OS X) when \c forgui is true.
*/
virtual docstring const print(key_modifier::state mod, bool forgui) const;
///
int key() const {
return key_;
}
private:
/// the Qt sym value
int key_;
/// the event string value
QString text_;
};
} // namespace lyx
#endif // QLYXKEYSYM_H