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 "InsetCollapsible.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. Alternatively, argument can be the icon path 60 without extension specified with respect to the images directory. 61 62 buffer: argument can be one of "name", "path", "class". This inset output the 63 filename, path, and textclass of this buffer. 64 65 lyxinfo: argument must (presently) be "version". This inset outputs information 66 about the version of LyX currently in use. 67 68 There is currently no GUI, no menu entry for this inset. A user can define a 69 shortcut for "info-insert" (e.g. C-S-I), and 70 71 1. input the type and argument of this inset, e.g. "menu paste", in 72 the work area. 73 2. select the text and run "info-insert" (e.g. press C-S-I). 74 75 An alternative method is to enter command "info-insert type arg" in 76 the command buffer (view->Toolbar->Command Buffer). 77 78 */ 79 80 class InsetInfo : public InsetCollapsible { 81 public: 82 enum info_type { 83 UNKNOWN_INFO, // Invalid type 84 SHORTCUTS_INFO, // Keyboard shortcuts 85 SHORTCUT_INFO, // Keyboard shortcut 86 LYXRC_INFO, // RC entry 87 PACKAGE_INFO, // Availability of package 88 TEXTCLASS_INFO, // Availability of textclass 89 MENU_INFO, // Which menu item is used for certain function 90 ICON_INFO, // which toolbar icon is used for certain function 91 BUFFER_INFO, // Buffer related information 92 LYX_INFO // LyX version information 93 }; 94 95 /// 96 InsetInfo(Buffer * buf, std::string const & info = std::string()); 97 /// lyxCode()98 InsetCode lyxCode() const { return INFO_CODE; } 99 /// 100 docstring layoutName() const; 101 /// 102 Inset * editXY(Cursor & cur, int x, int y); 103 /** FIXME: we would like to do that, but then InsetText::updateBuffer breaks 104 * on info insets. Do we need to run this method on InsetInfo contents? 105 * Having a InsetInfo that hides an InsetText is really annoying, actually. 106 */ 107 ///bool isActive() const { return false; } 108 /// editable()109 bool editable() const { return false; } 110 /// hasSettings()111 bool hasSettings() const { return true; } 112 /// 113 void read(Lexer & lex); 114 /// 115 void write(std::ostream & os) const; 116 /// 117 std::string infoType() const; 118 /// infoName()119 std::string infoName() const { return name_; } 120 /// 121 bool validateModifyArgument(docstring const & argument) const; 122 /// 123 bool showInsetDialog(BufferView * bv) const; 124 /// 125 bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const; 126 /// 127 void doDispatch(Cursor & cur, FuncRequest & cmd); 128 /// Force inset into LTR environment if surroundings are RTL 129 bool forceLTR(OutputParams const &) const; 130 /// 131 void setInfo(std::string const & info); 132 /// update info_ and text 133 void updateInfo(); 134 /// 135 docstring toolTip(BufferView const & bv, int x, int y) const; 136 /// 137 std::string contextMenu(BufferView const &, int, int) const; 138 /// 139 std::string contextMenuName() const; 140 /// should paragraph indendation be omitted in any case? neverIndent()141 bool neverIndent() const { return true; } 142 143 private: 144 /// clone()145 virtual Inset * clone() const { return new InsetInfo(*this); } 146 /// 147 void error(std::string const & err); 148 /// 149 void setText(docstring const & str); 150 // make sure that the other version of setText is still available. 151 using InsetCollapsible::setText; 152 /// 153 info_type type_; 154 /// 155 std::string name_; 156 /// 157 bool force_ltr_; 158 }; 159 160 161 } // namespace lyx 162 163 #endif 164