lyx_mirror/src/insets/InsetNomencl.h

97 lines
2.3 KiB
C++

// -*- C++ -*-
/**
* \file InsetNomencl.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Lars Gullik Bjønnes
* \author O. U. Baran
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSET_NOMENCL_H
#define INSET_NOMENCL_H
#include "InsetCommand.h"
namespace lyx {
class LaTeXFeatures;
/** Used to insert nomenclature entries
*/
class InsetNomencl : public InsetCommand {
public:
///
InsetNomencl(InsetCommandParams const &);
///
docstring const getScreenLabel(Buffer const &) const;
///
EDITABLE editable() const { return IS_EDITABLE; }
/// Updates needed features for this inset.
void validate(LaTeXFeatures & features) const;
///
InsetCode lyxCode() const { return NOMENCL_CODE; }
///
int docbook(Buffer const &, odocstream &,
OutputParams const &) const;
///
int docbookGlossary(odocstream &) const;
///
static CommandInfo const * findInfo(std::string const &);
///
static std::string defaultCommand() { return "nomenclature"; };
///
static bool isCompatibleCommand(std::string const & s)
{ return s == "nomenclature"; }
private:
virtual Inset * clone() const {
return new InsetNomencl(params());
}
/// unique id for this nomenclature entry for docbook export
docstring nomenclature_entry_id;
};
class InsetPrintNomencl : public InsetCommand {
public:
///
InsetPrintNomencl(InsetCommandParams const &);
/// Updates needed features for this inset.
void validate(LaTeXFeatures & features) const;
// FIXME: This should be editable to set the label width (stored
// in params_["labelwidth"]).
// Currently the width can be read from file and written, but not
// changed.
///
EDITABLE editable() const { return NOT_EDITABLE; }
///
int docbook(Buffer const &, odocstream &,
OutputParams const &) const;
///
InsetCode lyxCode() const;
///
DisplayType display() const { return AlignCenter; }
///
docstring const getScreenLabel(Buffer const &) const;
///
static CommandInfo const * findInfo(std::string const &);
///
static std::string defaultCommand() { return "printnomenclature"; };
///
static bool isCompatibleCommand(std::string const & s)
{ return s == "printnomenclature"; }
private:
virtual Inset * clone() const {
return new InsetPrintNomencl(params());
}
};
} // namespace lyx
#endif