lyx_mirror/src/insets/InsetTOC.h
Richard Heck ecef54500d Introduce max_length parameter for plaintext() output routines,
so we can write a limited amount when using this for TOC and
tooltip output.

This should solve the problem with slowness that Kornel noticed,
which was caused by our trying to write an entire plaintext
bibliography every time we updated the TOC. We did that because
he had a bibliography inside a branch, and we use plaintext for
creating the tooltip that goes with the branch list.

Other related bugs were fixed along the way. E.g., it turns out
that, if someone had an InsetInclude inside a branch, then we would
have been writing a *plaintext file* for that inset every time we
updated the TOC. I wonder if some of the other reports of slowness
we have received might be due to this kind of issue?
2013-03-08 15:12:58 -05:00

81 lines
1.8 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 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 { return TOC_CODE; }
///
docstring layoutName() const;
///
DisplayType display() const { return AlignCenter; }
///
virtual void validate(LaTeXFeatures &) const;
///
int plaintext(odocstringstream & ods, OutputParams const & op,
size_t max_length = INT_MAX) const;
///
int docbook(odocstream &, OutputParams const &) const;
///
docstring xhtml(XHTMLStream & xs, OutputParams const &) const;
///
void doDispatch(Cursor & cur, FuncRequest & cmd);
///
bool clickable(int, int) const { 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:
/// \name Private functions inherited from Inset class
//@{
///
Inset * clone() const { return new InsetTOC(*this); }
//@}
/// \name Private functions inherited from InsetCommand class
//@{
///
docstring screenLabel() const;
//@}
};
} // namespace lyx
#endif