lyx_mirror/src/insets/InsetNewline.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

97 lines
2.0 KiB
C++

// -*- C++ -*-
/**
* \file InsetNewline.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author John Levon
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSET_NEWLINE_H
#define INSET_NEWLINE_H
#include "Inset.h"
namespace lyx {
class InsetNewlineParams
{
public:
/// The different kinds of spaces we support
enum Kind {
///
NEWLINE,
///
LINEBREAK
};
///
InsetNewlineParams() : kind(NEWLINE) {}
///
void write(std::ostream & os) const;
///
void read(Lexer & lex);
///
Kind kind;
};
class InsetNewline : public Inset
{
public:
///
InsetNewline();
///
InsetNewline(InsetNewlineParams par) : Inset(0)
{ params_.kind = par.kind; }
///
static void string2params(std::string const &, InsetNewlineParams &);
///
static std::string params2string(InsetNewlineParams const &);
private:
///
InsetNewlineParams params() const { return params_; }
///
InsetCode lyxCode() const { return NEWLINE_CODE; }
///
void metrics(MetricsInfo &, Dimension &) const;
///
void draw(PainterInfo & pi, int x, int y) const;
///
void latex(otexstream &, OutputParams const &) const;
///
int plaintext(odocstringstream & ods, OutputParams const & op,
size_t max_length = INT_MAX) const;
///
int docbook(odocstream &, OutputParams const &) const;
///
docstring xhtml(XHTMLStream &, OutputParams const &) const;
///
void read(Lexer & lex);
///
void write(std::ostream & os) const;
/// is this equivalent to a space (which is BTW different from
/// a line separator)?
bool isSpace() const { return true; }
///
ColorCode ColorName() const;
///
std::string contextMenuName() const;
///
Inset * clone() const { return new InsetNewline(*this); }
///
void doDispatch(Cursor & cur, FuncRequest & cmd);
///
bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
///
InsetNewlineParams params_;
};
} // namespace lyx
#endif // INSET_NEWLINE_H