lyx_mirror/src/insets/InsetIndex.h
Richard Heck 8e9410b3d0 After a hiatus, I'm returning to the rewrite of InsetCommandParams, the purpose of all of this being to make things more flexible, with the ultimate goal being biblatex support and a kind of InsetCommandFlex that will allow user-definable such things. The next step, really, is to fix up CiteEngine so that we can have different sets of parameters for InsetCitation depending upon what engine is in use. (Something like this also needs doing with InsetInclude.)
This patch reworks the machinery that holds information about what parameters there are and what their values are. There's enough flexibility here that true keyval support ought to be fairly easy at this point. I'll have a peek at that shortly.



git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23168 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-23 22:01:02 +00:00

84 lines
1.8 KiB
C++

// -*- C++ -*-
/**
* \file InsetIndex.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Lars Gullik Bjønnes
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSET_INDEX_H
#define INSET_INDEX_H
#include "InsetCollapsable.h"
#include "InsetCommand.h"
namespace lyx {
class LaTeXFeatures;
/** Used to insert index labels
*/
class InsetIndex : public InsetCollapsable {
public:
///
InsetIndex(BufferParams const &);
///
InsetIndex(InsetIndex const &);
///
EDITABLE editable() const { return IS_EDITABLE; }
///
InsetCode lyxCode() const { return INDEX_CODE; }
///
docstring name() const { return from_ascii("Index"); }
///
void write(Buffer const & buf, std::ostream & os) const;
///
int docbook(Buffer const &, odocstream &,
OutputParams const &) const;
/// should paragraph indendation be omitted in any case?
bool neverIndent(Buffer const &) const { return true; }
///
void addToToc(Buffer const &, ParConstIterator const &) const;
private:
///
virtual Inset * clone() const;
};
class InsetPrintIndex : public InsetCommand {
public:
///
InsetPrintIndex(InsetCommandParams const &);
/// Updates needed features for this inset.
void validate(LaTeXFeatures & features) const;
///
EDITABLE editable() const { return NOT_EDITABLE; }
///
InsetCode lyxCode() const;
///
DisplayType display() const { return AlignCenter; }
///
docstring const getScreenLabel(Buffer const &) const;
///
static ParamInfo const & findInfo(std::string const &);
///
static std::string defaultCommand() { return "printindex"; };
///
static bool isCompatibleCommand(std::string const & s)
{ return s == "printindex"; }
private:
virtual Inset * clone() const {
return new InsetPrintIndex(params());
}
};
} // namespace lyx
#endif