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

132 lines
2.7 KiB
C++

// -*- C++ -*-
/**
* \file InsetScript.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Georg Baum
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSET_SCRIPT_H
#define INSET_SCRIPT_H
#include "InsetText.h"
namespace lyx {
class InsetScriptParams
{
public:
enum Type {
Subscript,
Superscript
};
/// \c type defaults to Subscript
InsetScriptParams();
///
void write(std::ostream & os) const;
///
void read(Lexer & lex);
///
int shift(FontInfo const & font) const;
///
Type type;
};
/////////////////////////////////////////////////////////////////////////
//
// InsetScript
//
/////////////////////////////////////////////////////////////////////////
/// The subscript and superscript inset
class InsetScript : public InsetText
{
public:
///
InsetScript(Buffer *, InsetScriptParams const & = InsetScriptParams());
///
InsetScript(Buffer *, std::string const &);
///
~InsetScript();
///
static std::string params2string(InsetScriptParams const &);
///
static void string2params(std::string const &, InsetScriptParams &);
///
InsetScriptParams const & params() const { return params_; }
/// \name Public functions inherited from Inset class
//@{
///
InsetCode lyxCode() const { return SCRIPT_CODE; }
///
docstring layoutName() const;
///
DisplayType display() const;
///
void metrics(MetricsInfo &, Dimension &) const;
///
void draw(PainterInfo & pi, int x, int y) const;
///
void cursorPos(BufferView const & bv,
CursorSlice const & sl, bool boundary, int & x, int & y) const;
///
void write(std::ostream &) const;
///
void read(Lexer & lex);
///
bool neverIndent() const { return true; }
///
int plaintext(odocstringstream & ods, OutputParams const & op,
size_t max_length = INT_MAX) const;
///
int docbook(odocstream &, OutputParams const &) const;
///
void edit(Cursor & cur, bool front,
EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
///
Inset * editXY(Cursor & cur, int x, int y);
///
bool insetAllowed(InsetCode code) const;
///
bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
///
docstring toolTip(BufferView const & bv, int x, int y) const;
///
Inset * clone() const { return new InsetScript(*this); }
///
std::string contextMenuName() const;
//@}
/// \name Public functions inherited from InsetText class
//@{
///
bool allowMultiPar() const { return false; }
//@}
protected:
/// \name Protected functions inherited from Inset class
//@{
///
void doDispatch(Cursor & cur, FuncRequest & cmd);
//@}
private:
/// used by the constructors
void init();
///
friend class InsetScriptParams;
///
InsetScriptParams params_;
};
} // namespace lyx
#endif