Move isMultiCell() to Cursor, and use it.

[lyx.git] / src / insets / InsetInfo.h

diff --git a/src/insets/InsetInfo.h b/src/insets/InsetInfo.h
index e71b5e833396f4bd5fc476fd0605b4d9f1b17aba..0cd256dbdb61daa9416d7064c6e27695f145327a 100644 (file)
--- a/src/insets/InsetInfo.h
+++ b/src/insets/InsetInfo.h
@@ -14,11 +14,12 @@
 
 #include "InsetText.h"
 #include "RenderButton.h"
-#include "support/gettext.h"
 #include "Cursor.h"
+
+#include "support/gettext.h"
 #include "support/Translator.h"
 
-/* InsetInfo displays shortcuts, lyxrc, package and textclass 
+/* InsetInfo displays shortcuts, lyxrc, package and textclass
 availability and menu information in a non-editable boxed InsetText.
 
 Output of such an inset may vary from system to system, depending
@@ -29,15 +30,17 @@ uses it to display currently used shortcuts.
 
 This inset has two arguments: the type and argument of the information. The
 screen and latex output is the content of the information. An InsetInfo can
-have type "shortcut", "lyxrc", "package", "textclass", or "menu". Arguments
-and outputs vary by type.
+have type "shortcuts", "shortcut", "lyxrc", "package", "textclass", "menu",
+or "buffer". Arguments and outputs vary by type.
 
-shortcut: argument of this type of InsetInfo is the name of the LFUN such as
+shortcuts: argument of this type of InsetInfo is the name of the LFUN such as
     "math-insert \alpha". The syntax is the same as what is used in the bind
     and ui files. The output of this inset is all shortcuts for this LFUN
     separated by comma.
 
-lyxrc: argument is the name of the rc entry such as "bind_file". Look in 
+shortcut: the same as shortcuts, but only output the last shortcut.
+
+lyxrc: argument is the name of the rc entry such as "bind_file". Look in
     src/LyXRC.h for available entries. The output is the content of this RC
     entry.
 
@@ -52,16 +55,21 @@ menu: argument is the name of the LFUN such as "paste". The syntax is the same
     triggers this LFUN. For example, "File > Paste", where '>' is actually
     \lyxarrow (an InsetSpecialChar).
 
+icon: argument is the name of the LFUN such as "paste". The syntax is the same
+    as what is used in the bind and ui files. The output is the icon use in
+    the toolbar for this LFUN.
+
+buffer: argument can be one of "name", "path", "class". This inset output the
+    filename, path, and textclass of this buffer.
 
-Because this inset is intended to be used only by document maintainers,
-there is no GUI, no menu entry for this inset. A user can define a 
+There is currently no GUI, no menu entry for this inset. A user can define a
 shortcut for "info-insert" (e.g. C-S-I), and
 
-1. input the type and argument of this inset, e.g. "menu paste", in 
+1. input the type and argument of this inset, e.g. "menu paste", in
    the work area.
 2. select the text and run "info-insert" (e.g. press C-S-I).
 
-An alternative method is to enter command "info-insert type arg" in 
+An alternative method is to enter command "info-insert type arg" in
 the command buffer (view->Toolbar->Command Buffer).
 
 */
@@ -74,15 +82,18 @@ class InsetInfo : public InsetText {
 public:
        enum info_type {
                UNKNOWN_INFO,   // Invalid type
+               SHORTCUTS_INFO, // Keyboard shortcuts
                SHORTCUT_INFO,  // Keyboard shortcut
                LYXRC_INFO,     // RC entry
                PACKAGE_INFO,   // Availability of package
                TEXTCLASS_INFO, // Availability of textclass
                MENU_INFO,      // Which menu item is used for certain function
+               ICON_INFO,      // which toolbar icon is used for certain function
+               BUFFER_INFO,    // Buffer related information
        };
 
        ///
-       InsetInfo(BufferParams const & bp, std::string const & info = std::string());
+       InsetInfo(Buffer const & buf, std::string const & info = std::string());
        ///
        Inset * editXY(Cursor & cur, int x, int y);
        ///
@@ -90,31 +101,47 @@ public:
        ///
        void draw(PainterInfo & pi, int x, int y) const;
        ///
-       void read(Buffer const &, Lexer & lex);
+       void read(Lexer & lex);
+       ///
+       void write(std::ostream & os) const;
+       ///
+       std::string infoType() const;
+       ///
+       std::string infoName() const { return name_; }
+       ///
+       bool validate(docstring const & argument) const;
        ///
-       void write(Buffer const & buf, std::ostream & os) const;
+       bool showInsetDialog(BufferView * bv) const;
+       ///
+       bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
        ///
        void doDispatch(Cursor & cur, FuncRequest & cmd);
        ///
        InsetCode lyxCode() const { return INFO_CODE; }
        ///
        void setInfo(std::string const & info);
+       /// update info_ and text
+       void updateInfo();
        ///
        bool setMouseHover(bool mouse_hover);
+       ///
+       docstring toolTip(BufferView const & bv, int x, int y) const;
+       ///
+       docstring contextMenu(BufferView const &, int, int) const;
 
 private:
        /// The translator between the information type enum and corresponding string.
        Translator<info_type, std::string> const & nameTranslator() const;
-       /// update info_ and text
-       void updateInfo();
        ///
        virtual Inset * clone() const { return new InsetInfo(*this); }
        ///
+       void error(std::string const & err);
+       ///
+       void setText(docstring const & str);
+       ///
        info_type type_;
        ///
        std::string name_;
-       /// store the buffer parameter
-       BufferParams const & bp_;
        ///
        bool mouse_hover_;
 };