4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
11 * Full author contact details are available in file CREDITS.
17 #include "FuncRequest.h"
18 #include "KeySequence.h"
20 #include "support/strfwd.h"
22 #include <boost/shared_ptr.hpp>
29 /// Defines key maps and actions for key sequences
33 System, //< loaded from a bind file
34 UserBind, //< \bind loaded from user.bind
35 UserUnbind, //< \unbind loaded from user.bind, with corresponding
36 //< entry in system bind file
37 UserExtraUnbind //< \unbind loaded from user.bind, without
38 //< corresponding entry in system bind file.
41 * Bind/Unbind a key sequence to an action.
42 * @return 0 on success, or position in string seq where error
44 * See KeySequence::parse for the syntax of the seq string
46 size_t bind(std::string const & seq, FuncRequest const & func);
47 size_t unbind(std::string const & seq, FuncRequest const & func);
50 * Define/Undefine an action for a key sequence.
51 * @param r internal recursion level
53 void bind(KeySequence * seq, FuncRequest const & func,
55 void unbind(KeySequence * seq, FuncRequest const & func,
59 // if a keybinding has been defined.
60 bool hasBinding(KeySequence const & seq, FuncRequest const & func,
66 /** Parse a bind file. If a valid unbind_map is given, put \unbind
67 * bindings to a separate KeyMap. This is used in the Shortcut preference
68 * dialog where main and user bind files are loaded separately so \unbind
69 * in user.bind can not nullify \bind in the master bind file.
71 * @param bind_file bind file
72 * @param unbind_map pointer to a KeyMap that holds \unbind bindings
74 bool read(std::string const & bind_file, KeyMap * unbind_map = 0);
76 /** write to a bind file.
77 * @param append append to the bind_file instead of overwrite it
78 * @param unbind use \unbind instead of \bind, indicating this KeyMap
79 * actually record unbind maps.
81 void write(std::string const & bind_file, bool append, bool unbind = false) const;
84 * print all available keysyms
85 * @param forgui true if the string should use translations and
88 docstring const print(bool forgui) const;
91 * Look up a key press in the keymap.
92 * @param key the keysym
93 * @param mod the modifiers
94 * @param seq the current key sequence so far
95 * @return the action / LFUN_COMMAND_PREFIX / LFUN_UNKNOWN_ACTION
98 lookup(KeySymbol const & key, KeyModifier mod, KeySequence * seq) const;
101 typedef std::vector<KeySequence> Bindings;
103 /// Given an action, find all keybindings.
104 Bindings findBindings(FuncRequest const & func) const;
106 /// Given an action, print the keybindings.
107 docstring printBindings(FuncRequest const & func) const;
110 Binding(FuncRequest const & r, KeySequence const & s, ItemType t)
111 : request(r), sequence(s), tag(t) {}
113 KeySequence sequence;
114 KeyMap::ItemType tag;
116 typedef std::vector<Binding> BindingList;
118 * Return all lfun and their associated bindings.
119 * @param unbound list unbound (func without any keybinding) as well
120 * @param tag an optional tag to indicate the source of the bindinglist
122 BindingList listBindings(bool unbound, ItemType tag = System) const;
125 * Given an action, find the first 1-key binding (if it exists).
126 * The KeySymbol pointer is 0 is no key is found.
127 * [only used by the Qt/Mac frontend]
129 std::pair<KeySymbol, KeyModifier>
130 find1keybinding(FuncRequest const & func) const;
133 * Returns a string of the given keysym, with modifiers.
134 * @param key the key as a keysym
135 * @param mod the modifiers
137 static std::string const printKeySym(KeySymbol const & key,
142 typedef std::pair<KeyModifier, KeyModifier> ModifierPair;
150 /// Keymap for prefix keys
151 boost::shared_ptr<KeyMap> table;
152 /// Action for !prefix keys
157 * Given an action, find all keybindings
158 * @param func the action
159 * @param prefix a sequence to prepend the results
161 Bindings findBindings(FuncRequest const & func,
162 KeySequence const & prefix) const;
164 void listBindings(BindingList & list, KeySequence const & prefix,
167 /// is the table empty ?
168 bool empty() const { return table.empty(); }
170 typedef std::vector<Key> Table;
175 /// Implementation is in LyX.cpp
176 extern KeyMap & theTopLevelKeymap();