mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-12-04 22:32:19 +00:00
963a0aa466
Move the enum definition RowFlags in its own include file, to avoid loading Inset.h. Document it more thoroughly. Rename RowAfter to AlwaysBreakAfter. Add CanBreakInside (rows that can be themselves broken). This allow to differentiate elements before bodyPos() and allows to remove a parameter to shortenIfNeeded(). Make the Inset::rowFlags() method return int instead of RowFlags, as should be done for all the bitwise flags. Remove the hand-made bitwise operators. Set R::E::row_flags when creating elements. * INSET elements use the inset's rowFLags(); * virtual element forbid breaking before them, and inherit the *After flags from the previous element of the row; * STRING elements usr CanBreakInside, except before bodyPos. More stuff may be added later.
91 lines
2.2 KiB
C++
91 lines
2.2 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"
|
|
|
|
#include "Toc.h"
|
|
|
|
|
|
namespace lyx {
|
|
|
|
class Paragraph;
|
|
|
|
/// Used to insert table of contents and similar lists
|
|
/// at present, supports only \tableofcontents and \listoflistings.
|
|
/// Other such commands, such as \listoffigures, are supported
|
|
/// by InsetFloatList.
|
|
class InsetTOC : public InsetCommand {
|
|
public:
|
|
///
|
|
InsetTOC(Buffer * buf, InsetCommandParams const &);
|
|
|
|
/// \name Public functions inherited from Inset class
|
|
//@{
|
|
///
|
|
InsetCode lyxCode() const override { return TOC_CODE; }
|
|
///
|
|
docstring layoutName() const override;
|
|
///
|
|
int rowFlags() const override { return Display; }
|
|
///
|
|
void validate(LaTeXFeatures &) const override;
|
|
///
|
|
int plaintext(odocstringstream & ods, OutputParams const & op,
|
|
size_t max_length = INT_MAX) const override;
|
|
///
|
|
void docbook(XMLStream &, OutputParams const &) const override;
|
|
///
|
|
docstring xhtml(XMLStream & xs, OutputParams const &) const override;
|
|
///
|
|
void doDispatch(Cursor & cur, FuncRequest & cmd) override;
|
|
///
|
|
bool clickable(BufferView const &, int, int) const override { return true; }
|
|
//@}
|
|
|
|
/// \name Static public methods obligated for InsetCommand derived classes
|
|
//@{
|
|
///
|
|
static ParamInfo const & findInfo(std::string const &);
|
|
///
|
|
static std::string defaultCommand() { return "tableofcontents"; }
|
|
///
|
|
static bool isCompatibleCommand(std::string const & cmd);
|
|
//@}
|
|
|
|
private:
|
|
///
|
|
void makeTOCWithDepth(XMLStream & xs, Toc const & toc, const OutputParams & op) const;
|
|
///
|
|
void makeTOCNoDepth(XMLStream & xs, Toc const & toc, const OutputParams & op) const;
|
|
///
|
|
void makeTOCEntry(XMLStream & xs, Paragraph const & par, OutputParams const & op) const;
|
|
|
|
/// \name Private functions inherited from Inset class
|
|
//@{
|
|
///
|
|
Inset * clone() const override { return new InsetTOC(*this); }
|
|
//@}
|
|
|
|
/// \name Private functions inherited from InsetCommand class
|
|
//@{
|
|
///
|
|
docstring screenLabel() const override;
|
|
//@}
|
|
};
|
|
|
|
|
|
} // namespace lyx
|
|
|
|
#endif
|