4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
15 #include "InsetCollapsible.h"
22 /* InsetInfo displays shortcuts, lyxrc, package and textclass
23 availability and menu information in a non-editable boxed InsetText.
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.
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 "shortcuts", "shortcut", "lyxrc", "package", "textclass", "menu",
34 "buffer" or "vcs". Arguments and outputs vary by type.
36 date: argument of this type of InsetInfo is either a fixed date type of
37 "long" (long localized date, with weekday, as provided by QLocale),
38 "short" (short localized date, with two-digit year, as provided by QLocale),
39 "loclong" (long localized date, without weekday, defined in languages),
40 "locmedium" (medium localized date, defined in languages),
41 "locshort" (short localized date, with four-digit year, defined in languages),
42 "ISO" (ISO-conforming date)
43 or a custom date using the QDate syntax.
44 The output is a localized formatted (current) date.
46 moddate: Same as date.
47 The output is a localized formatted date of last file modification (saving).
49 fixdate: Same as date. A fixed date (in ISO format) is prepended to the argument,
51 The output is a localized formatted fix date.
53 shortcuts: argument is the name of the LFUN such as "math-insert \alpha".
54 The syntax is the same as what is used in the bind and ui files.
55 The output of this inset is all shortcuts for this LFUN separated by comma.
57 shortcut: the same as shortcuts, but only output the last shortcut.
59 lyxrc: argument is the name of the rc entry such as "bind_file". Look in
60 src/LyXRC.h for available entries. The output is the content of this RC
63 package: argument is the name of a latex package such as "listings". The
64 output is "yes" or "no", indicating the availability of this package.
66 textclass: argument is the name a textclass such as "article". The output is
67 "yes" or "no", indicating the availability of this textclass.
69 menu: argument is the name of the LFUN such as "paste". The syntax is the same
70 as what is used in the bind and ui files. The output is the menu item that
71 triggers this LFUN. For example, "File > Paste", where '>' is actually
72 \lyxarrow (an InsetSpecialChar).
74 icon: argument is the name of the LFUN such as "paste". The syntax is the same
75 as what is used in the bind and ui files. The output is the icon use in
76 the toolbar for this LFUN. Alternatively, argument can be the icon path
77 without extension specified with respect to the images directory.
79 buffer: argument can be one of "name", "path", "class". This inset output the
80 filename, path, and textclass of this buffer.
82 lyxinfo: argument must (presently) be "version". This inset outputs information
83 about the version of LyX currently in use.
85 vcs: argument can be one of "revision", "tree-revision", "author", "time", "date".
86 This insets outputs revision control information, if available.
88 There is currently no GUI, no menu entry for this inset. A user can define a
89 shortcut for "info-insert" (e.g. C-S-I), and
91 1. input the type and argument of this inset, e.g. "menu paste", in
93 2. select the text and run "info-insert" (e.g. press C-S-I).
95 An alternative method is to enter command "info-insert type arg" in
96 the command buffer (view->Toolbar->Command Buffer).
100 class InsetInfoParams {
103 DATE_INFO, // Current Date
104 MODDATE_INFO, // Date of last modification
105 FIXDATE_INFO, // Fix date
106 BUFFER_INFO, // Buffer related information
107 VCS_INFO, // Version control information
108 PACKAGE_INFO, // Availability of package
109 TEXTCLASS_INFO, // Availability of textclass
110 SHORTCUTS_INFO, // Keyboard shortcuts
111 SHORTCUT_INFO, // Keyboard shortcut
112 LYXRC_INFO, // RC entry
113 MENU_INFO, // Which menu item is used for certain function
114 ICON_INFO, // which toolbar icon is used for certain function
115 LYX_INFO, // LyX version information
116 UNKNOWN_INFO, // Invalid type
119 docstring getDate(std::string const, QDate const date = QDate::currentDate()) const;
121 std::vector<std::pair<std::string,docstring>> getArguments(Buffer const * buf,
122 std::string const &) const;
126 std::string infoType() const;
130 Language const * lang;
136 extern InsetInfoParams infoparams;
138 class InsetInfo : public InsetCollapsible {
141 InsetInfo(Buffer * buf, std::string const & info = std::string());
143 InsetCode lyxCode() const { return INFO_CODE; }
145 docstring layoutName() const;
147 Inset * editXY(Cursor & cur, int x, int y);
148 /** FIXME: we would like to do that, but then InsetText::updateBuffer breaks
149 * on info insets. Do we need to run this method on InsetInfo contents?
150 * Having a InsetInfo that hides an InsetText is really annoying, actually.
152 ///bool isActive() const { return false; }
154 bool editable() const { return false; }
156 bool hasSettings() const { return true; }
158 void read(Lexer & lex);
160 void write(std::ostream & os) const;
162 bool validateModifyArgument(docstring const & argument) const;
164 bool showInsetDialog(BufferView * bv) const;
166 bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
168 void doDispatch(Cursor & cur, FuncRequest & cmd);
169 /// Force inset into LTR environment if surroundings are RTL
170 bool forceLTR() const;
172 void setInfo(std::string const & info);
174 void updateBuffer(ParIterator const & it, UpdateType utype);
176 docstring toolTip(BufferView const & bv, int x, int y) const;
178 std::string contextMenu(BufferView const &, int, int) const;
180 std::string contextMenuName() const;
181 /// should paragraph indendation be omitted in any case?
182 bool neverIndent() const { return true; }
184 InsetInfoParams params() const { return params_; }
188 virtual Inset * clone() const { return new InsetInfo(*this); }
190 void error(docstring const & err, Language const *);
192 void info(docstring const & err, Language const *);
194 void setText(docstring const & str, Language const *);
195 // make sure that the other version of setText is still available.
196 using InsetCollapsible::setText;
200 InsetInfoParams params_;
202 friend class InsetInfoParams;