#include "support/docstream.h"
#include <boost/shared_ptr.hpp>
+#include <boost/tuple/tuple.hpp>
#include <vector>
#include <deque>
*/
size_t bind(std::string const & seq, FuncRequest const & func);
- // Parse a bind file
- bool read(std::string const & bind_file);
+ // Unbind a key sequence
+ size_t unbind(std::string const & seq, FuncRequest const & func);
+
+ // if a keybinding has been defined.
+ bool hasBinding(KeySequence const & seq, FuncRequest const & func,
+ unsigned int r = 0);
+
+ // clear all bindings
+ void clear();
+
+ /** Parse a bind file. If a valid unbind_map is given, put \unbind
+ * bindings to a separate KeyMap. This is used in the Shortcut preference
+ * dialog where main and user bind files are loaded separately so \unbind
+ * in user.bind can not nullify \bind in the master bind file.
+ *
+ * @param bind_file bind file
+ * @param unbind_map pointer to a KeyMap that holds \unbind bindings
+ */
+ bool read(std::string const & bind_file, KeyMap * unbind_map = NULL);
+
+ /** write to a bind file.
+ * @param append append to the bind_file instead of overwrite it
+ * @param unbind use \unbind instead of \bind, indicating this KeyMap
+ * actually record unbind maps.
+ */
+ void write(std::string const & bind_file, bool append, bool unbind=false) const;
/**
* print all available keysyms
/// Given an action, print the keybindings.
docstring const printbindings(FuncRequest const & func) const;
+ typedef boost::tuple<FuncRequest, KeySequence, int> Binding;
+ typedef std::vector<Binding> BindingList;
+ /**
+ * Return all lfun and their associated bindings.
+ * @param unbound list unbound (func without any keybinding) as well
+ * @param tag an optional tag to indicate the source of the bindinglist
+ */
+ BindingList listBindings(bool unbound, int tag = 0) const;
+
/**
* Given an action, find the first 1-key binding (if it exists).
* The KeySymbol pointer is 0 is no key is found.
typedef std::pair<KeyModifier, KeyModifier> ModifierPair;
+
private:
///
struct Key {
*/
void defkey(KeySequence * seq, FuncRequest const & func,
unsigned int r = 0);
+ void delkey(KeySequence * seq, FuncRequest const & func,
+ unsigned int r = 0);
/**
* Given an action, find all keybindings
*/
Bindings findbindings(FuncRequest const & func,
KeySequence const & prefix) const;
+
+ void listBindings(BindingList & list, KeySequence const & prefix,
+ int tag) const;
/// is the table empty ?
bool empty() const { return table.empty(); }