mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-09 18:31:04 +00:00
6c300f72a2
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@15422 a592a061-630c-0410-9148-cb99ea01b6c8
121 lines
2.7 KiB
C++
121 lines
2.7 KiB
C++
// -*- C++ -*-
|
||
/**
|
||
* \file kbsequence.h
|
||
* This file is part of LyX, the document processor.
|
||
* Licence details can be found in the file COPYING.
|
||
*
|
||
* \author Lars Gullik Bjønnes
|
||
* \author Jean-Marc Lasgouttes
|
||
*
|
||
* Full author contact details are available in file CREDITS.
|
||
*/
|
||
|
||
#ifndef KBSEQUENCE_H
|
||
#define KBSEQUENCE_H
|
||
|
||
#include "frontends/key_state.h"
|
||
#include "frontends/LyXKeySym.h"
|
||
|
||
#include <string>
|
||
#include <vector>
|
||
|
||
|
||
namespace lyx {
|
||
|
||
class kb_keymap;
|
||
class FuncRequest;
|
||
|
||
/// Holds a key sequence and the current and standard keymaps
|
||
class kb_sequence {
|
||
public:
|
||
typedef std::vector<LyXKeySymPtr> KeySequence;
|
||
|
||
friend class kb_keymap;
|
||
|
||
///
|
||
kb_sequence(kb_keymap * std, kb_keymap * cur)
|
||
: stdmap(std), curmap(cur), deleted_(false) {}
|
||
|
||
/**
|
||
* Add a key to the key sequence and look it up in the curmap
|
||
* if the latter is defined.
|
||
* @param keysym the key to add
|
||
* @param mod modifier mask
|
||
* @param nmod which modifiers to mask out for equality test
|
||
* @return the action matching this key sequence or LFUN_UNKNOWN_ACTION
|
||
*/
|
||
FuncRequest const &
|
||
addkey(LyXKeySymPtr keysym, key_modifier::state mod,
|
||
key_modifier::state nmod = key_modifier::none);
|
||
|
||
/**
|
||
* Add a sequence of keys from a string to the sequence
|
||
* @return string::npos if OK, else error position in string
|
||
*
|
||
* Keys in the string must be separated with whitespace;
|
||
* Use the keysym names used by XStringToKeysym, f.ex.
|
||
* "Space", "a", "Return", ...
|
||
* Prefixes are S-, C-, M- for shift, control, meta
|
||
* Prefixes can also be ignored by using the Tilde "~"
|
||
* f.ex.: "~S-Space".
|
||
*/
|
||
std::string::size_type parse(std::string const & s);
|
||
|
||
/**
|
||
* Return the current sequence as a string.
|
||
* @see parse()
|
||
*/
|
||
std::string const print() const;
|
||
|
||
/**
|
||
* Return the current sequence and available options as
|
||
* a string. No options are added if no curmap kb map exists.
|
||
*/
|
||
std::string const printOptions() const;
|
||
|
||
/// Mark the sequence as deleted.
|
||
void mark_deleted();
|
||
|
||
/// Reset sequence to become "deleted"
|
||
void reset();
|
||
|
||
/// clear in full
|
||
void clear();
|
||
|
||
bool deleted() const {
|
||
return deleted_;
|
||
}
|
||
|
||
/// length of sequence
|
||
KeySequence::size_type length() const {
|
||
return sequence.size();
|
||
}
|
||
|
||
/// Keymap to use if a new sequence is starting
|
||
kb_keymap * stdmap;
|
||
|
||
/// Keymap to use for the next key
|
||
kb_keymap * curmap;
|
||
|
||
private:
|
||
/**
|
||
* Array holding the current key sequence as KeySyms.
|
||
* If sequence[length - 1] < 0xff it can be used as ISO8859 char
|
||
*/
|
||
KeySequence sequence;
|
||
|
||
typedef std::pair<key_modifier::state, key_modifier::state>
|
||
modifier_pair;
|
||
|
||
/// modifiers for keys in the sequence
|
||
std::vector<modifier_pair> modifiers;
|
||
|
||
/// is keysequence deleted ?
|
||
bool deleted_;
|
||
};
|
||
|
||
|
||
} // namespace lyx
|
||
|
||
#endif
|