lyx_mirror/src/insets/InsetNote.h
Stefan Schimanski 36dbec4506 * Lazy MathData to avoid unneeded interpretation of macro definitions
* DocIterator as MacroPosition
* Iterative search for macro in scope until a visible one is found.
This include the ability to resolve macro inside nested text insets.
* Speed up macro lookups by factor 2: only getMacro(name) call, no
further hasMacro(name) call before
* Both way child/master support
* Correct macro scope for multi-paragraph environments
* Correct macro scope for multi-depth-paragraphs
* Buffer::updateMacros made const
* Update macros when loaded (of master and child)
* Do not remove too many braces when unfolding a macro. This could
lead to a data loss because the relationship between arguments of
macros can be mixed up if nested macros are unfold at once.
* Reduce dependencies to MetricsInfo in MathMacro   
* Update macros when needed. Normally it's done just before doing
metrics. But in cases without a brace around some constructs (like
\left(bla\right)) there is some help needed.


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@22241 a592a061-630c-0410-9148-cb99ea01b6c8
2007-12-21 20:42:46 +00:00

122 lines
2.5 KiB
C++

// -*- C++ -*-
/**
* \file InsetNote.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Angus Leeming
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSETNOTE_H
#define INSETNOTE_H
#include "InsetCollapsable.h"
#include "MailInset.h"
namespace lyx {
class InsetNoteParams {
public:
enum Type {
Note,
Comment,
Greyedout
};
/// \c type defaults to Note
InsetNoteParams();
///
void write(std::ostream & os) const;
///
void read(Lexer & lex);
///
Type type;
};
/** The PostIt note inset, and other annotations
*/
class InsetNote : public InsetCollapsable {
public:
///
InsetNote(BufferParams const &, std::string const &);
///
~InsetNote();
///
virtual docstring const editMessage() const;
///
InsetCode lyxCode() const { return NOTE_CODE; }
///
docstring name() const;
///
virtual DisplayType display() const;
///
void write(Buffer const &, std::ostream &) const;
///
void read(Buffer const & buf, Lexer & lex);
///
void setButtonLabel();
/// show the note dialog
bool showInsetDialog(BufferView * bv) const;
///
bool isMacroScope(Buffer const & buf) const;
///
int latex(Buffer const &, odocstream &, OutputParams const &) const;
///
int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
///
int docbook(Buffer const &, odocstream &, OutputParams const &) const;
///
void validate(LaTeXFeatures &) const;
///
InsetNoteParams const & params() const { return params_; }
///
bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
// Update the counters of this inset and of its contents
virtual void updateLabels(Buffer const &, ParIterator const &);
protected:
InsetNote(InsetNote const &);
///
virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
private:
friend class InsetNoteParams;
virtual Inset * clone() const;
/// used by the constructors
void init();
///
InsetNoteParams params_;
};
class InsetNoteMailer : public MailInset {
public:
///
InsetNoteMailer(InsetNote & inset);
///
virtual Inset & inset() const { return inset_; }
///
virtual std::string const & name() const { return name_; }
///
virtual std::string const inset2string(Buffer const &) const;
///
static std::string const params2string(InsetNoteParams const &);
///
static void string2params(std::string const &, InsetNoteParams &);
private:
///
static std::string const name_;
///
InsetNote & inset_;
};
} // namespace lyx
#endif