X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FKeyMap.h;h=849ba0cdad6ee5f089a0ff1b478cb76128a0fe1d;hb=5333998570902b22c3db30af63ddbe8d91304310;hp=b4f4cd133125f8af918461f5a837fe62b57a1dd2;hpb=5a579070c4541be19db1bd10727b600353a50d83;p=lyx.git diff --git a/src/KeyMap.h b/src/KeyMap.h index b4f4cd1331..849ba0cdad 100644 --- a/src/KeyMap.h +++ b/src/KeyMap.h @@ -4,7 +4,7 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes * \author Jean-Marc Lasgouttes * \author John Levon * @@ -19,13 +19,16 @@ #include "support/strfwd.h" -#include - +#include #include namespace lyx { +namespace support { + class FileName; +} + /// Defines key maps and actions for key sequences class KeyMap { public: @@ -37,6 +40,12 @@ public: UserExtraUnbind //< \unbind loaded from user.bind, without //< corresponding entry in system bind file. }; + enum BindReadType { + MissingOK, //< It's OK if this file is missing. + Fallback, //< If missing, fallback to default "cua". This should only + //< be used when attempting to read the user-secified bind file. + Default //< Report error and return. + }; /** * Bind/Unbind a key sequence to an action. * @return 0 on success, or position in string seq where error @@ -56,22 +65,26 @@ public: 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 void clear(); - /** Parse a bind file. If a valid unbind_map is given, put \unbind + /** 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 + * @param rt how to respond if the file can't be found */ - bool read(std::string const & bind_file, KeyMap * unbind_map = 0); + bool read(std::string const & bind_file, KeyMap * unbind_map = 0, + BindReadType rt = Default); /** write to a bind file. * @param append append to the bind_file instead of overwrite it @@ -104,7 +117,9 @@ public: 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, + bool const untranslated = false) const; struct Binding { Binding(FuncRequest const & r, KeySequence const & s, ItemType t) @@ -112,7 +127,7 @@ public: FuncRequest request; KeySequence sequence; KeyMap::ItemType tag; - }; + }; typedef std::vector BindingList; /** * Return all lfun and their associated bindings. @@ -148,11 +163,22 @@ private: /// Modifier masks ModifierPair mod; /// Keymap for prefix keys - boost::shared_ptr table; + std::shared_ptr prefixes; /// Action for !prefix keys FuncRequest func; }; + enum ReturnValues { + ReadOK, + ReadError, + FileError, + FormatMismatch + }; + /// + bool read(support::FileName const & bind_file, KeyMap * unbind_map = 0); + /// + ReturnValues readWithoutConv(support::FileName const & bind_file, KeyMap * unbind_map = 0); + /** * Given an action, find all keybindings * @param func the action @@ -160,7 +186,7 @@ private: */ Bindings findBindings(FuncRequest const & func, KeySequence const & prefix) const; - + void listBindings(BindingList & list, KeySequence const & prefix, ItemType tag) const;