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

110 lines
2.3 KiB
C++

// -*- C++ -*-
/**
* \file InsetPhantom.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Uwe Stöhr
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSET_PHANTOM_H
#define INSET_PHANTOM_H
#include "InsetCollapsable.h"
namespace lyx {
class InsetPhantomParams
{
public:
enum Type {
Phantom,
HPhantom,
VPhantom
};
/// \c type defaults to Phantom
InsetPhantomParams();
///
void write(std::ostream & os) const;
///
void read(Lexer & lex);
///
Type type;
};
/////////////////////////////////////////////////////////////////////////
//
// InsetPhantom
//
/////////////////////////////////////////////////////////////////////////
/// The phantom inset
class InsetPhantom : public InsetCollapsable
{
public:
///
InsetPhantom(Buffer *, std::string const &);
///
~InsetPhantom();
///
static std::string params2string(InsetPhantomParams const &);
///
static void string2params(std::string const &, InsetPhantomParams &);
///
InsetPhantomParams const & params() const { return params_; }
private:
///
InsetCode lyxCode() const { return PHANTOM_CODE; }
///
docstring layoutName() const;
///
void metrics(MetricsInfo &, Dimension &) const;
///
void draw(PainterInfo & pi, int x, int y) const;
///
void write(std::ostream &) const;
///
void read(Lexer & lex);
///
void setButtonLabel();
/// show the phantom dialog
bool showInsetDialog(BufferView * bv) const;
///
bool neverIndent() const { return true; }
///
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;
/// Makes no sense fof XHTML.
docstring xhtml(XHTMLStream &, OutputParams const &) const;
///
bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
///
void doDispatch(Cursor & cur, FuncRequest & cmd);
///
docstring toolTip(BufferView const & bv, int x, int y) const;
///
Inset * clone() const { return new InsetPhantom(*this); }
/// used by the constructors
void init();
///
std::string contextMenuName() const;
///
friend class InsetPhantomParams;
///
InsetPhantomParams params_;
};
} // namespace lyx
#endif // INSET_PHANTOM_H