src/insets/InsetInfo.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetInfo.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Bo Peng
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSET_INFO_H
  13 #define INSET_INFO_H
  14
  15 #include "InsetText.h"
  16 #include "RenderButton.h"
  17 #include "Cursor.h"
  18
  19 #include "support/gettext.h"
  20 #include "support/Translator.h"
  21
  22 /* InsetInfo displays shortcuts, lyxrc, package and textclass
  23 availability and menu information in a non-editable boxed InsetText.
  24
  25 Output of such an inset may vary from system to system, depending
  26 on LyX and LaTeX configurations. Two LyX help files, LaTeXConfig.lyx
  27 and Shortcuts.lyx make heavy use of this inset. The former uses it
  28 to display the availability of packages and textclasses, the latter
  29 uses it to display currently used shortcuts.
  30
  31 This inset has two arguments: the type and argument of the information. The
  32 screen and latex output is the content of the information. An InsetInfo can
  33 have type "shortcut", "lyxrc", "package", "textclass", "menu", or "buffer".
  34 Arguments and outputs vary by type.
  35
  36 shortcut: argument of this type of InsetInfo is the name of the LFUN such as
  37     "math-insert \alpha". The syntax is the same as what is used in the bind
  38     and ui files. The output of this inset is all shortcuts for this LFUN
  39     separated by comma.
  40
  41 lyxrc: argument is the name of the rc entry such as "bind_file". Look in
  42     src/LyXRC.h for available entries. The output is the content of this RC
  43     entry.
  44
  45 package: argument is the name of a latex package such as "listings". The
  46     output is "yes" or "no", indicating the availability of this package.
  47
  48 textclass: argument is the name a textclass such as "article". The output is
  49     "yes" or "no", indicating the availability of this textclass.
  50
  51 menu: argument is the name of the LFUN such as "paste". The syntax is the same
  52     as what is used in the bind and ui files. The output is the menu item that
  53     triggers this LFUN. For example, "File > Paste", where '>' is actually
  54     \lyxarrow (an InsetSpecialChar).
  55
  56 buffer: argument can be one of "name", "path", "class". This inset output the
  57     filename, path, and textclass of this buffer.
  58
  59 There is currently no GUI, no menu entry for this inset. A user can define a
  60 shortcut for "info-insert" (e.g. C-S-I), and
  61
  62 1. input the type and argument of this inset, e.g. "menu paste", in
  63    the work area.
  64 2. select the text and run "info-insert" (e.g. press C-S-I).
  65
  66 An alternative method is to enter command "info-insert type arg" in
  67 the command buffer (view->Toolbar->Command Buffer).
  68
  69 */
  70
  71 namespace lyx {
  72
  73 /** Used to insert index labels
  74   */
  75 class InsetInfo : public InsetText {
  76 public:
  77         enum info_type {
  78                 UNKNOWN_INFO,   // Invalid type
  79                 SHORTCUT_INFO,  // Keyboard shortcut
  80                 LYXRC_INFO,     // RC entry
  81                 PACKAGE_INFO,   // Availability of package
  82                 TEXTCLASS_INFO, // Availability of textclass
  83                 MENU_INFO,      // Which menu item is used for certain function
  84                 BUFFER_INFO,    // Buffer related information
  85         };
  86
  87         ///
  88         InsetInfo(Buffer const & buf, std::string const & info = std::string());
  89         ///
  90         Inset * editXY(Cursor & cur, int x, int y);
  91         ///
  92         EDITABLE editable() const { return NOT_EDITABLE; }
  93         ///
  94         void draw(PainterInfo & pi, int x, int y) const;
  95         ///
  96         void read(Lexer & lex);
  97         ///
  98         void write(std::ostream & os) const;
  99         ///
 100         void doDispatch(Cursor & cur, FuncRequest & cmd);
 101         ///
 102         InsetCode lyxCode() const { return INFO_CODE; }
 103         ///
 104         void setInfo(std::string const & info);
 105         /// update info_ and text
 106         void updateInfo();
 107         ///
 108         bool setMouseHover(bool mouse_hover);
 109         ///
 110         docstring toolTip(BufferView const & bv, int x, int y) const;
 111
 112 private:
 113         /// The translator between the information type enum and corresponding string.
 114         Translator<info_type, std::string> const & nameTranslator() const;
 115         ///
 116         virtual Inset * clone() const { return new InsetInfo(*this); }
 117         ///
 118         info_type type_;
 119         ///
 120         std::string name_;
 121         ///
 122         bool mouse_hover_;
 123 };
 124
 125
 126
 127 } // namespace lyx
 128
 129 #endif