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 "InsetCollapsable.h"
  16
  17 namespace lyx {
  18
  19 class Cursor;
  20
  21 /* InsetInfo displays shortcuts, lyxrc, package and textclass
  22 availability and menu information in a non-editable boxed InsetText.
  23
  24 Output of such an inset may vary from system to system, depending
  25 on LyX and LaTeX configurations. Two LyX help files, LaTeXConfig.lyx
  26 and Shortcuts.lyx make heavy use of this inset. The former uses it
  27 to display the availability of packages and textclasses, the latter
  28 uses it to display currently used shortcuts.
  29
  30 This inset has two arguments: the type and argument of the information. The
  31 screen and latex output is the content of the information. An InsetInfo can
  32 have type "shortcuts", "shortcut", "lyxrc", "package", "textclass", "menu",
  33 or "buffer". Arguments and outputs vary by type.
  34
  35 shortcuts: argument of this type of InsetInfo is the name of the LFUN such as
  36     "math-insert \alpha". The syntax is the same as what is used in the bind
  37     and ui files. The output of this inset is all shortcuts for this LFUN
  38     separated by comma.
  39
  40 shortcut: the same as shortcuts, but only output the last shortcut.
  41
  42 lyxrc: argument is the name of the rc entry such as "bind_file". Look in
  43     src/LyXRC.h for available entries. The output is the content of this RC
  44     entry.
  45
  46 package: argument is the name of a latex package such as "listings". The
  47     output is "yes" or "no", indicating the availability of this package.
  48
  49 textclass: argument is the name a textclass such as "article". The output is
  50     "yes" or "no", indicating the availability of this textclass.
  51
  52 menu: argument is the name of the LFUN such as "paste". The syntax is the same
  53     as what is used in the bind and ui files. The output is the menu item that
  54     triggers this LFUN. For example, "File > Paste", where '>' is actually
  55     \lyxarrow (an InsetSpecialChar).
  56
  57 icon: argument is the name of the LFUN such as "paste". The syntax is the same
  58     as what is used in the bind and ui files. The output is the icon use in
  59     the toolbar for this LFUN.
  60
  61 buffer: argument can be one of "name", "path", "class". This inset output the
  62     filename, path, and textclass of this buffer.
  63
  64 lyxinfo: argument must (presently) be "version". This inset outputs information
  65                 about the version of LyX currently in use.
  66
  67 There is currently no GUI, no menu entry for this inset. A user can define a
  68 shortcut for "info-insert" (e.g. C-S-I), and
  69
  70 1. input the type and argument of this inset, e.g. "menu paste", in
  71    the work area.
  72 2. select the text and run "info-insert" (e.g. press C-S-I).
  73
  74 An alternative method is to enter command "info-insert type arg" in
  75 the command buffer (view->Toolbar->Command Buffer).
  76
  77 */
  78
  79 class InsetInfo : public InsetCollapsable {
  80 public:
  81         enum info_type {
  82                 UNKNOWN_INFO,   // Invalid type
  83                 SHORTCUTS_INFO, // Keyboard shortcuts
  84                 SHORTCUT_INFO,  // Keyboard shortcut
  85                 LYXRC_INFO,     // RC entry
  86                 PACKAGE_INFO,   // Availability of package
  87                 TEXTCLASS_INFO, // Availability of textclass
  88                 MENU_INFO,      // Which menu item is used for certain function
  89                 ICON_INFO,      // which toolbar icon is used for certain function
  90                 BUFFER_INFO,    // Buffer related information
  91                 LYX_INFO,       // LyX version information
  92         };
  93
  94         ///
  95         InsetInfo(Buffer * buf, std::string const & info = std::string());
  96         ///
  97         InsetCode lyxCode() const { return INFO_CODE; }
  98         ///
  99         docstring name() const;
 100         ///
 101         Inset * editXY(Cursor & cur, int x, int y);
 102         ///
 103         bool editable() const { return false; }
 104         ///
 105         bool hasSettings() const { return true; }
 106         ///
 107         void read(Lexer & lex);
 108         ///
 109         void write(std::ostream & os) const;
 110         ///
 111         std::string infoType() const;
 112         ///
 113         std::string infoName() const { return name_; }
 114         ///
 115         bool validateModifyArgument(docstring const & argument) const;
 116         ///
 117         bool showInsetDialog(BufferView * bv) const;
 118         ///
 119         bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
 120         ///
 121         void doDispatch(Cursor & cur, FuncRequest & cmd);
 122         ///
 123         void setInfo(std::string const & info);
 124         /// update info_ and text
 125         void updateInfo();
 126         ///
 127         docstring toolTip(BufferView const & bv, int x, int y) const;
 128         ///
 129         docstring contextMenu(BufferView const &, int, int) const;
 130         /// should paragraph indendation be ommitted in any case?
 131         bool neverIndent() const { return true; }
 132
 133 private:
 134         ///
 135         virtual Inset * clone() const { return new InsetInfo(*this); }
 136         ///
 137         void error(std::string const & err);
 138         ///
 139         void setText(docstring const & str);
 140         // make sure that the other version of setText is still available.
 141         using InsetCollapsable::setText;
 142         ///
 143         info_type type_;
 144         ///
 145         std::string name_;
 146 };
 147
 148
 149 } // namespace lyx
 150
 151 #endif