mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-16 07:55:41 +00:00
141 lines
3.5 KiB
C++
141 lines
3.5 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(Buffer * buf, InsetCommandParams const &);
|
|
|
|
/// \name Public functions inherited from Inset class
|
|
//@{
|
|
///
|
|
docstring toolTip(BufferView const & bv, int x, int y) const override;
|
|
///
|
|
bool hasSettings() const override { return true; }
|
|
/// Updates needed features for this inset.
|
|
void validate(LaTeXFeatures & features) const override;
|
|
///
|
|
void addToToc(DocIterator const & di, bool output_active,
|
|
UpdateType utype, TocBackend & backend) const override;
|
|
///
|
|
InsetCode lyxCode() const override { return NOMENCL_CODE; }
|
|
///
|
|
int plaintext(odocstringstream & ods, OutputParams const & op,
|
|
size_t max_length = INT_MAX) const override;
|
|
///
|
|
void docbook(XMLStream &, OutputParams const &) const override;
|
|
/// Does nothing at the moment.
|
|
docstring xhtml(XMLStream &, OutputParams const &) const override;
|
|
//@}
|
|
|
|
/// \name Static public methods obligated for InsetCommand derived classes
|
|
//@{
|
|
///
|
|
static ParamInfo const & findInfo(std::string const &);
|
|
///
|
|
static std::string defaultCommand() { return "nomenclature"; }
|
|
///
|
|
static bool isCompatibleCommand(std::string const & s)
|
|
{ return s == "nomenclature"; }
|
|
//@}
|
|
|
|
private:
|
|
/// \name Private functions inherited from Inset class
|
|
//@{
|
|
///
|
|
Inset * clone() const override { return new InsetNomencl(*this); }
|
|
//@}
|
|
|
|
/// \name Private functions inherited from InsetCommand class
|
|
//@{
|
|
///
|
|
docstring screenLabel() const override;
|
|
//@}
|
|
|
|
/// unique id for this nomenclature entry for docbook export
|
|
docstring nomenclature_entry_id;
|
|
};
|
|
|
|
|
|
class InsetPrintNomencl : public InsetCommand {
|
|
public:
|
|
///
|
|
InsetPrintNomencl(Buffer * buf, InsetCommandParams const &);
|
|
|
|
/// \name Public functions inherited from Inset class
|
|
//@{
|
|
/// Updates needed features for this inset.
|
|
void validate(LaTeXFeatures & features) const override;
|
|
///
|
|
void docbook(XMLStream &, OutputParams const &) const override;
|
|
///
|
|
docstring xhtml(XMLStream &, OutputParams const &) const override;
|
|
///
|
|
InsetCode lyxCode() const override;
|
|
///
|
|
bool hasSettings() const override { return true; }
|
|
///
|
|
RowFlags rowFlags() const override { return Display; }
|
|
///
|
|
void latex(otexstream &, OutputParams const &) const override;
|
|
///
|
|
std::string contextMenuName() const override;
|
|
//@}
|
|
|
|
/// \name Static public methods obligated for InsetCommand derived classes
|
|
//@{
|
|
///
|
|
static ParamInfo const & findInfo(std::string const &);
|
|
///
|
|
static std::string defaultCommand() { return "printnomenclature"; }
|
|
///
|
|
static bool isCompatibleCommand(std::string const & s)
|
|
{ return s == "printnomenclature"; }
|
|
//@}
|
|
|
|
private:
|
|
/// \name Private functions inherited from Inset class
|
|
//@{
|
|
///
|
|
Inset * clone() const override { return new InsetPrintNomencl(*this); }
|
|
///
|
|
bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus & status) const override;
|
|
///
|
|
void doDispatch(Cursor & cur, FuncRequest & cmd) override;
|
|
///
|
|
docstring layoutName() const override { return from_ascii("PrintNomencl"); }
|
|
//@}
|
|
|
|
/// \name Private functions inherited from InsetCommand class
|
|
//@{
|
|
///
|
|
docstring screenLabel() const override;
|
|
//@}
|
|
};
|
|
|
|
} // namespace lyx
|
|
|
|
#endif
|