lyx_mirror/src/insets/InsetTOC.h
Richard Heck 228948534e A comment, and a minor change.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@32732 a592a061-630c-0410-9148-cb99ea01b6c8
2010-01-01 02:08:22 +00:00

56 lines
1.3 KiB
C++

// -*- C++ -*-
/**
* \file InsetTOC.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_TOC_H
#define INSET_TOC_H
#include "InsetCommand.h"
namespace lyx {
/// Used to insert table of contents and similar lists
/// at present, supports only \tableofcontents. Other
/// such commands, such as \listoffigures, are supported
/// by InsetFloatList.
class InsetTOC : public InsetCommand {
public:
///
InsetTOC(Buffer * buf, InsetCommandParams const &);
///
docstring screenLabel() const;
///
InsetCode lyxCode() const { return TOC_CODE; }
///
DisplayType display() const { return AlignCenter; }
///
int plaintext(odocstream &, OutputParams const &) const;
///
int docbook(odocstream &, OutputParams const &) const;
///
docstring xhtml(XHTMLStream & xs, OutputParams const &) const;
///
static ParamInfo const & findInfo(std::string const &);
///
static std::string defaultCommand() { return "tableofcontents"; }
///
static bool isCompatibleCommand(std::string const & cmd)
{ return cmd == defaultCommand(); }
private:
Inset * clone() const { return new InsetTOC(*this); }
};
} // namespace lyx
#endif