/// Defines key maps and actions for key sequences
class KeyMap {
public:
+ enum ItemType {
+ System, //< loaded from a bind file
+ UserBind, //< \bind loaded from user.bind
+ UserUnbind, //< \unbind loaded from user.bind, with corresponding
+ //< entry in system bind file
+ UserExtraUnbind //< \unbind loaded from user.bind, without
+ //< corresponding entry in system bind file.
+ };
/**
* Bind/Unbind a key sequence to an action.
* @return 0 on success, or position in string seq where error
unsigned int r = 0);
- // if a keybinding has been defined.
- bool hasBinding(KeySequence const & seq, FuncRequest const & func,
- unsigned int r = 0);
+ /// returns the function bound to this key sequence, or
+ /// FuncRequest::unknown if no binding exists for it.
+ /// @param r an internal recursion counter
+ // FIXME Surely there's a better way to do that?
+ FuncRequest getBinding(KeySequence const & seq, unsigned int r = 0);
- // clear all bindings
+ /// clear all bindings
void clear();
/** Parse a bind file. If a valid unbind_map is given, put \unbind
* @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;
+ void write(std::string const & bind_file, bool append, bool unbind = false) const;
/**
* print all available keysyms
* @return the action / LFUN_COMMAND_PREFIX / LFUN_UNKNOWN_ACTION
*/
FuncRequest const &
- lookup(KeySymbol const & key, KeyModifier mod, KeySequence * seq) const;
+ lookup(KeySymbol const & key, KeyModifier mod, KeySequence * seq) const;
///
typedef std::vector<KeySequence> Bindings;
Bindings findBindings(FuncRequest const & func) const;
/// Given an action, print the keybindings.
- docstring printBindings(FuncRequest const & func) const;
+ docstring printBindings(FuncRequest const & func,
+ KeySequence::outputFormat format) const;
struct Binding {
- Binding(FuncRequest const & r, KeySequence const & s, int t)
+ Binding(FuncRequest const & r, KeySequence const & s, ItemType t)
: request(r), sequence(s), tag(t) {}
FuncRequest request;
KeySequence sequence;
- int tag;
+ KeyMap::ItemType tag;
};
typedef std::vector<Binding> BindingList;
/**
* @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;
+ BindingList listBindings(bool unbound, ItemType tag = System) const;
/**
* Given an action, find the first 1-key binding (if it exists).
* [only used by the Qt/Mac frontend]
*/
std::pair<KeySymbol, KeyModifier>
- find1keybinding(FuncRequest const & func) const;
+ find1keybinding(FuncRequest const & func) const;
/**
* Returns a string of the given keysym, with modifiers.
* @param prefix a sequence to prepend the results
*/
Bindings findBindings(FuncRequest const & func,
- KeySequence const & prefix) const;
+ KeySequence const & prefix) const;
void listBindings(BindingList & list, KeySequence const & prefix,
- int tag) const;
+ ItemType tag) const;
/// is the table empty ?
bool empty() const { return table.empty(); }