4 * Copyright 2001 the LyX Team
5 * Read the file COPYING
20 /// Holds a key sequence and the current and standard keymaps
23 friend class kb_keymap;
26 kb_sequence(kb_keymap * std, kb_keymap * cur)
27 : stdmap(std), curmap(cur), length_(0), deleted_(false) {}
32 * Add a key to the key sequence and look it up in the curmap
33 * if the latter is defined.
34 * @param mod modifier mask
35 * @param nmod which modifiers to mask out for equality test
36 * @return the action matching this key sequence or LFUN_UNKNOWN_ACTION
38 int addkey(unsigned int key, unsigned int mod, unsigned int nmod = 0);
41 * Add a sequence of keys from a string to the sequence
42 * @return string::npos if OK, else error position in string
44 * Keys in the string must be separated with whitespace;
45 * Use the keysym names used by XStringToKeysym
46 * Prefixes are S-, C-, M- for shift, control, meta
48 string::size_type parse(string const & s);
51 * Return the current sequence as a string.
54 string const print() const;
57 * Return the current sequence and available options as
58 * a string. No options are added if no curmap kb map exists.
60 string const printOptions() const;
62 /// Mark the sequence as deleted.
65 /// Return the ISO value of the last keysym in sequence, or 0
68 /// Reset sequence to become "deleted"
74 bool deleted() const {
78 /// length of sequence
79 std::vector<unsigned int>::size_type length() const {
83 /// Keymap to use if a new sequence is starting
86 /// Keymap to use for the next key
90 /// get the keysym of last in sequence
91 unsigned int getsym() const;
94 * Array holding the current key sequence.
95 * If sequence[length-1] < 0xff it can be used as ISO8859 char
97 std::vector<unsigned int> sequence;
99 /// modifiers for keys in the sequence
100 std::vector<unsigned int> modifiers;
102 /// Current length of key sequence
103 std::vector<unsigned int>::size_type length_;
105 /// is keysequence deleted ?