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;
42 /// Does nothing at the moment.
43 docstring xhtml(odocstream &, OutputParams const &) const;
45 int docbookGlossary(odocstream &) const;
47 static ParamInfo const & findInfo(std::string const &);
49 static std::string defaultCommand() { return "nomenclature"; };
51 static bool isCompatibleCommand(std::string const & s)
52 { return s == "nomenclature"; }
54 Inset * clone() const { return new InsetNomencl(*this); }
55 /// unique id for this nomenclature entry for docbook export
56 docstring nomenclature_entry_id;
60 class InsetPrintNomencl : public InsetCommand {
63 InsetPrintNomencl(InsetCommandParams const &);
64 /// Updates needed features for this inset.
65 void validate(LaTeXFeatures & features) const;
67 int docbook(odocstream &, OutputParams const &) const;
68 /// Does nothing at the moment.
69 docstring xhtml(odocstream &, OutputParams const &) const;
71 InsetCode lyxCode() const;
73 bool hasSettings() const { return true; }
75 DisplayType display() const { return AlignCenter; }
77 docstring screenLabel() const;
79 static ParamInfo const & findInfo(std::string const &);
81 static std::string defaultCommand() { return "printnomenclature"; };
83 static bool isCompatibleCommand(std::string const & s)
84 { return s == "printnomenclature"; }
86 int latex(odocstream &, OutputParams const &) const;
88 docstring contextMenu(BufferView const & bv, int x, int y) const;
91 void doDispatch(Cursor & cur, FuncRequest & cmd);
93 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
95 Inset * clone() const { return new InsetPrintNomencl(*this); }