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 * Bind/Unbind a key sequence to an action.
34 * @return 0 on success, or position in string seq where error
36 * See KeySequence::parse for the syntax of the seq string
38 size_t bind(std::string
const & seq
, FuncRequest
const & func
);
39 size_t unbind(std::string
const & seq
, FuncRequest
const & func
);
42 * Define/Undefine an action for a key sequence.
43 * @param r internal recursion level
45 void bind(KeySequence
* seq
, FuncRequest
const & func
,
47 void unbind(KeySequence
* seq
, FuncRequest
const & func
,
51 // if a keybinding has been defined.
52 bool hasBinding(KeySequence
const & seq
, FuncRequest
const & func
,
58 /** Parse a bind file. If a valid unbind_map is given, put \unbind
59 * bindings to a separate KeyMap. This is used in the Shortcut preference
60 * dialog where main and user bind files are loaded separately so \unbind
61 * in user.bind can not nullify \bind in the master bind file.
63 * @param bind_file bind file
64 * @param unbind_map pointer to a KeyMap that holds \unbind bindings
66 bool read(std::string
const & bind_file
, KeyMap
* unbind_map
= 0);
68 /** write to a bind file.
69 * @param append append to the bind_file instead of overwrite it
70 * @param unbind use \unbind instead of \bind, indicating this KeyMap
71 * actually record unbind maps.
73 void write(std::string
const & bind_file
, bool append
, bool unbind
=false) const;
76 * print all available keysyms
77 * @param forgui true if the string should use translations and
80 docstring
const print(bool forgui
) const;
83 * Look up a key press in the keymap.
84 * @param key the keysym
85 * @param mod the modifiers
86 * @param seq the current key sequence so far
87 * @return the action / LFUN_COMMAND_PREFIX / LFUN_UNKNOWN_ACTION
90 lookup(KeySymbol
const & key
, KeyModifier mod
, KeySequence
* seq
) const;
93 typedef std::vector
<KeySequence
> Bindings
;
95 /// Given an action, find all keybindings.
96 Bindings
findBindings(FuncRequest
const & func
) const;
98 /// Given an action, print the keybindings.
99 docstring
printBindings(FuncRequest
const & func
) const;
102 Binding(FuncRequest
const & r
, KeySequence
const & s
, int t
)
103 : request(r
), sequence(s
), tag(t
) {}
105 KeySequence sequence
;
108 typedef std::vector
<Binding
> BindingList
;
110 * Return all lfun and their associated bindings.
111 * @param unbound list unbound (func without any keybinding) as well
112 * @param tag an optional tag to indicate the source of the bindinglist
114 BindingList
listBindings(bool unbound
, int tag
= 0) const;
117 * Given an action, find the first 1-key binding (if it exists).
118 * The KeySymbol pointer is 0 is no key is found.
119 * [only used by the Qt/Mac frontend]
121 std::pair
<KeySymbol
, KeyModifier
>
122 find1keybinding(FuncRequest
const & func
) const;
125 * Returns a string of the given keysym, with modifiers.
126 * @param key the key as a keysym
127 * @param mod the modifiers
129 static std::string
const printKeySym(KeySymbol
const & key
,
134 typedef std::pair
<KeyModifier
, KeyModifier
> ModifierPair
;
142 /// Keymap for prefix keys
143 boost::shared_ptr
<KeyMap
> table
;
144 /// Action for !prefix keys
149 * Given an action, find all keybindings
150 * @param func the action
151 * @param prefix a sequence to prepend the results
153 Bindings
findBindings(FuncRequest
const & func
,
154 KeySequence
const & prefix
) const;
156 void listBindings(BindingList
& list
, KeySequence
const & prefix
,
159 /// is the table empty ?
160 bool empty() const { return table
.empty(); }
162 typedef std::vector
<Key
> Table
;
167 /// Implementation is in LyX.cpp
168 extern KeyMap
& theTopLevelKeymap();