src/kbsequence.h

   1 // -*- C++ -*-
   2 /**
   3  * \file kbsequence.h
   4  * Copyright 2001 the LyX Team
   5  * Read the file COPYING
   6  */
   7
   8 #ifndef KBSEQUENCE_H
   9 #define KBSEQUENCE_H
  10
  11 #ifdef __GNUG__
  12 #pragma interface
  13 #endif
  14
  15 #include <vector>
  16 #include "LString.h"
  17
  18 #include "commandtags.h"
  19
  20 class kb_keymap;
  21
  22 /// Holds a key sequence and the current and standard keymaps
  23 class kb_sequence {
  24 public:
  25         friend class kb_keymap;
  26
  27         ///
  28         kb_sequence(kb_keymap * std, kb_keymap * cur)
  29                 : stdmap(std), curmap(cur), length_(0), deleted_(false) {}
  30
  31
  32
  33         /**
  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          * @return the action matching this key sequence or LFUN_UNKNOWN_ACTION
  38          */
  39         kb_action addkey(unsigned int key, unsigned int mod);
  40
  41         /**
  42          * Add a sequence of keys from a string to the sequence
  43          * @return string::npos if OK, else error position in string
  44          *
  45          * Keys in the string must be separated with whitespace;
  46          * Use the keysym names used by XStringToKeysym
  47          * Prefixes are S-, C-, M- for shift, control, meta
  48          */
  49         string::size_type parse(string const & s);
  50
  51         /**
  52          * Return the current sequence as a string.
  53          * @see parse()
  54          */
  55         string const print() const;
  56
  57         /**
  58          * Return the current sequence and available options as
  59          * a string. No options are added if no curmap kb map exists.
  60          */
  61         string const printOptions() const;
  62
  63         /// Mark the sequence as deleted.
  64         void mark_deleted();
  65
  66         /// Return the ISO value of the last keysym in sequence, or 0
  67         char getiso() const;
  68
  69         /// Reset sequence to become "deleted"
  70         void reset();
  71
  72         /// clear in full
  73         void clear();
  74
  75         bool deleted() const {
  76                 return deleted_;
  77         }
  78
  79         /// length of sequence
  80         std::vector<unsigned int>::size_type length() const {
  81                 return length_;
  82         }
  83
  84         /// Keymap to use if a new sequence is starting
  85         kb_keymap * stdmap;
  86
  87         /// Keymap to use for the next key
  88         kb_keymap * curmap;
  89
  90 private:
  91         /// get the keysym of last in sequence
  92         unsigned int getsym() const;
  93
  94         /**
  95          * Array holding the current key sequence.
  96          * If sequence[length-1] < 0xff it can be used as ISO8859 char
  97          */
  98         std::vector<unsigned int> sequence;
  99
 100         /// modifiers for keys in the sequence
 101         std::vector<unsigned int> modifiers;
 102
 103         /// Current length of key sequence
 104         std::vector<unsigned int>::size_type length_;
 105
 106         /// is keysequence deleted ?
 107         bool deleted_;
 108 };
 109
 110 #endif