4 * Copyright 2001 the LyX Team
5 * Read the file COPYING
18 #include "commandtags.h"
22 /// Holds a key sequence and the current and standard keymaps
25 friend class kb_keymap;
28 kb_sequence(kb_keymap * std, kb_keymap * cur)
29 : stdmap(std), curmap(cur), length_(0), deleted_(false) {}
34 * Add a key to the key sequence and look it up in the curmap
35 * if the latter is defined.
36 * @param mod modifier mask
37 * @param nmod which modifiers to mask out for equality test
38 * @return the action matching this key sequence or LFUN_UNKNOWN_ACTION
40 kb_action addkey(unsigned int key, unsigned int mod, unsigned int nmod = 0);
43 * Add a sequence of keys from a string to the sequence
44 * @return string::npos if OK, else error position in string
46 * Keys in the string must be separated with whitespace;
47 * Use the keysym names used by XStringToKeysym
48 * Prefixes are S-, C-, M- for shift, control, meta
50 string::size_type parse(string const & s);
53 * Return the current sequence as a string.
56 string const print() const;
59 * Return the current sequence and available options as
60 * a string. No options are added if no curmap kb map exists.
62 string const printOptions() const;
64 /// Mark the sequence as deleted.
67 /// Return the ISO value of the last keysym in sequence, or 0
70 /// Reset sequence to become "deleted"
76 bool deleted() const {
80 /// length of sequence
81 std::vector<unsigned int>::size_type length() const {
85 /// Keymap to use if a new sequence is starting
88 /// Keymap to use for the next key
92 /// get the keysym of last in sequence
93 unsigned int getsym() const;
96 * Array holding the current key sequence.
97 * If sequence[length-1] < 0xff it can be used as ISO8859 char
99 std::vector<unsigned int> sequence;
101 /// modifiers for keys in the sequence
102 std::vector<unsigned int> modifiers;
104 /// Current length of key sequence
105 std::vector<unsigned int>::size_type length_;
107 /// is keysequence deleted ?