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 EDITABLE editable() const { return IS_EDITABLE; }
34 /// Updates needed features for this inset.
35 void validate(LaTeXFeatures & features) const;
37 InsetCode lyxCode() const { return NOMENCL_CODE; }
39 int docbook(odocstream &, OutputParams const &) const;
41 int docbookGlossary(odocstream &) const;
43 static ParamInfo const & findInfo(std::string const &);
45 static std::string defaultCommand() { return "nomenclature"; };
47 static bool isCompatibleCommand(std::string const & s)
48 { return s == "nomenclature"; }
50 Inset * clone() const { return new InsetNomencl(*this); }
51 /// unique id for this nomenclature entry for docbook export
52 docstring nomenclature_entry_id;
56 class InsetPrintNomencl : public InsetCommand {
59 InsetPrintNomencl(InsetCommandParams const &);
60 /// Updates needed features for this inset.
61 void validate(LaTeXFeatures & features) const;
62 // FIXME: This should be editable to set the label width (stored
63 // in params_["labelwidth"]).
64 // Currently the width can be read from file and written, but not
67 EDITABLE editable() const { return NOT_EDITABLE; }
69 int docbook(odocstream &, OutputParams const &) const;
71 InsetCode lyxCode() const;
73 DisplayType display() const { return AlignCenter; }
75 docstring screenLabel() const;
77 static ParamInfo const & findInfo(std::string const &);
79 static std::string defaultCommand() { return "printnomenclature"; };
81 static bool isCompatibleCommand(std::string const & s)
82 { return s == "printnomenclature"; }
84 Inset * clone() const { return new InsetPrintNomencl(*this); }