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 "InsetText.h"
16 #include "RenderButton.h"
19 #include "support/Translator.h"
21 /* InsetInfo displays shortcuts, lyxrc, package and textclass
22 availability and menu information in a non-editable boxed InsetText.
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.
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 "shortcut", "lyxrc", "package", "textclass", or "menu". Arguments
33 and outputs vary by type.
35 shortcut: 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
40 lyxrc: argument is the name of the rc entry such as "bind_file". Look in
41 src/LyXRC.h for available entries. The output is the content of this RC
44 package: argument is the name of a latex package such as "listings". The
45 output is "yes" or "no", indicating the availability of this package.
47 textclass: argument is the name a textclass such as "article". The output is
48 "yes" or "no", indicating the availability of this textclass.
50 menu: argument is the name of the LFUN such as "paste". The syntax is the same
51 as what is used in the bind and ui files. The output is the menu item that
52 triggers this LFUN. For example, "File > Paste", where '>' is actually
53 \lyxarrow (an InsetSpecialChar).
56 Because this inset is intended to be used only by document maintainers,
57 there is no GUI, no menu entry for this inset. A user can define a
58 shortcut for "info-insert" (e.g. C-S-I), and
60 1. input the type and argument of this inset, e.g. "menu paste", in
62 2. select the text and run "info-insert" (e.g. press C-S-I).
64 An alternative method is to enter command "info-insert type arg" in
65 the command buffer (view->Toolbar->Command Buffer).
71 /** Used to insert index labels
73 class InsetInfo : public InsetText {
76 UNKNOWN_INFO, // Invalid type
77 SHORTCUT_INFO, // Keyboard shortcut
78 LYXRC_INFO, // RC entry
79 PACKAGE_INFO, // Availability of package
80 TEXTCLASS_INFO, // Availability of textclass
81 MENU_INFO, // Which menu item is used for certain function
85 InsetInfo(BufferParams const & bp, std::string const & info = std::string());
87 Inset * editXY(Cursor & cur, int x, int y);
89 EDITABLE editable() const { return NOT_EDITABLE; }
91 void draw(PainterInfo & pi, int x, int y) const;
93 void read(Buffer const &, Lexer & lex);
95 void write(Buffer const & buf, std::ostream & os) const;
97 void doDispatch(Cursor & cur, FuncRequest & cmd);
99 InsetCode lyxCode() const { return INFO_CODE; }
101 void setInfo(std::string const & info);
103 bool setMouseHover(bool mouse_hover);
106 /// The translator between the information type enum and corresponding string.
107 Translator<info_type, std::string> const & nameTranslator() const;
108 /// update info_ and text
111 virtual Inset * clone() const { return new InsetInfo(*this); }
116 /// store the buffer parameter
117 BufferParams const & bp_;