X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fkbsequence.h;h=6dc269a0357687f9f3e343c8927992a5a4036848;hb=e7f4618bcce770369cf46335c2c7f0164b4b8857;hp=c63a9c72247a57f28239eed710e62205feebe8b0;hpb=99d1627a471b92f403598d03dfc861ddc3c11be0;p=lyx.git diff --git a/src/kbsequence.h b/src/kbsequence.h index c63a9c7224..6dc269a035 100644 --- a/src/kbsequence.h +++ b/src/kbsequence.h @@ -1,21 +1,29 @@ // -*- C++ -*- /** * \file kbsequence.h - * Copyright 2001 the LyX Team - * Read the file COPYING + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. + * + * \author Lars Gullik Bjønnes + * \author Jean-Marc Lasgouttes + * + * Full author contact details are available in file CREDITS. */ #ifndef KBSEQUENCE_H #define KBSEQUENCE_H -#include - #include "frontends/key_state.h" #include "frontends/LyXKeySym.h" -#include "LString.h" + +#include #include + +namespace lyx { + class kb_keymap; +class FuncRequest; /// Holds a key sequence and the current and standard keymaps class kb_sequence { @@ -36,8 +44,9 @@ public: * @param nmod which modifiers to mask out for equality test * @return the action matching this key sequence or LFUN_UNKNOWN_ACTION */ - int addkey(LyXKeySymPtr keysym, key_modifier::state mod, - key_modifier::state nmod = key_modifier::none); + FuncRequest const & + addkey(LyXKeySymPtr keysym, key_modifier::state mod, + key_modifier::state nmod = key_modifier::none); /** * Add a sequence of keys from a string to the sequence @@ -50,19 +59,23 @@ public: * Prefixes can also be ignored by using the Tilde "~" * f.ex.: "~S-Space". */ - string::size_type parse(string const & s); + std::string::size_type parse(std::string const & s); /** * Return the current sequence as a string. + * @param forgui true if the string should use translations and + * special characters. * @see parse() */ - string const print() const; + docstring const print(bool forgui) const; /** * Return the current sequence and available options as * a string. No options are added if no curmap kb map exists. + * @param forgui true if the string should use translations and + * special characters. */ - string const printOptions() const; + docstring const printOptions(bool forgui) const; /// Mark the sequence as deleted. void mark_deleted(); @@ -105,4 +118,7 @@ private: bool deleted_; }; + +} // namespace lyx + #endif