4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
10 * Full author contact details are available in file CREDITS.
13 #ifndef INSET_NOMENCL_H
14 #define INSET_NOMENCL_H
17 #include "InsetCommand.h"
24 /** Used to insert nomenclature entries
26 class InsetNomencl : public InsetCommand {
29 InsetNomencl(InsetCommandParams const &);
31 docstring screenLabel() const;
33 docstring toolTip(BufferView const & bv, int x, int y) const;
35 bool hasSettings() const { return true; }
36 /// Updates needed features for this inset.
37 void validate(LaTeXFeatures & features) const;
39 InsetCode lyxCode() const { return NOMENCL_CODE; }
41 int docbook(odocstream &, OutputParams const &) const;
43 int docbookGlossary(odocstream &) const;
45 static ParamInfo const & findInfo(std::string const &);
47 static std::string defaultCommand() { return "nomenclature"; };
49 static bool isCompatibleCommand(std::string const & s)
50 { return s == "nomenclature"; }
52 Inset * clone() const { return new InsetNomencl(*this); }
53 /// unique id for this nomenclature entry for docbook export
54 docstring nomenclature_entry_id;
58 class InsetPrintNomencl : public InsetCommand {
61 InsetPrintNomencl(InsetCommandParams const &);
62 /// Updates needed features for this inset.
63 void validate(LaTeXFeatures & features) const;
65 int docbook(odocstream &, OutputParams const &) const;
67 InsetCode lyxCode() const;
69 bool hasSettings() const { return true; }
71 DisplayType display() const { return AlignCenter; }
73 docstring screenLabel() const;
75 static ParamInfo const & findInfo(std::string const &);
77 static std::string defaultCommand() { return "printnomenclature"; };
79 static bool isCompatibleCommand(std::string const & s)
80 { return s == "printnomenclature"; }
82 int latex(odocstream &, OutputParams const &) const;
84 docstring contextMenu(BufferView const & bv, int x, int y) const;
87 void doDispatch(Cursor & cur, FuncRequest & cmd);
89 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
91 Inset * clone() const { return new InsetPrintNomencl(*this); }