lyx_mirror/src/insets/InsetIndex.h

// -*- 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<EFBFBD>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 CommandInfo const * findInfo(std::string const & cmdName = "");
	///
	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