X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetNote.h;h=dd580da8a024b8895e1a8933bfddb3bab8df7e4a;hb=9b530e59c2b74828f3a68f3bb7ee3dee0365cdc0;hp=d234966071db6b5225373581843cceefeb847bc2;hpb=c3a8b3a566e9e90f9ade72acbc723232d721d0b1;p=lyx.git diff --git a/src/insets/InsetNote.h b/src/insets/InsetNote.h index d234966071..dd580da8a0 100644 --- a/src/insets/InsetNote.h +++ b/src/insets/InsetNote.h @@ -9,16 +9,16 @@ * Full author contact details are available in file CREDITS. */ -#ifndef INSETNOTE_H -#define INSETNOTE_H +#ifndef INSET_NOTE_H +#define INSET_NOTE_H #include "InsetCollapsable.h" -#include "MailInset.h" namespace lyx { -class InsetNoteParams { +class InsetNoteParams +{ public: enum Type { Note, @@ -36,88 +36,82 @@ public: }; -/** The PostIt note inset, and other annotations +///////////////////////////////////////////////////////////////////////// +// +// InsetNote +// +///////////////////////////////////////////////////////////////////////// -*/ -class InsetNote : public InsetCollapsable { +/// The PostIt note inset, and other annotations +class InsetNote : public InsetCollapsable +{ public: /// - InsetNote(BufferParams const &, std::string const &); + InsetNote(Buffer *, std::string const &); /// ~InsetNote(); /// - virtual docstring const editMessage() const; + static std::string params2string(InsetNoteParams const &); + /// + static void string2params(std::string const &, InsetNoteParams &); + /// + InsetNoteParams const & params() const { return params_; } +private: /// InsetCode lyxCode() const { return NOTE_CODE; } /// - docstring name() const; + docstring layoutName() const; + /// + DisplayType display() const; + /** returns false if, when outputing LaTeX, font changes should + be closed before generating this inset. This is needed for + insets that may contain several paragraphs */ + bool inheritFont() const { return params_.type == InsetNoteParams::Note; } + /// Is the content of this inset part of the output document? + bool producesOutput() const + { return params_.type == InsetNoteParams::Greyedout; } /// - virtual DisplayType display() const; + bool allowSpellCheck() const; /// - void write(Buffer const &, std::ostream &) const; + FontInfo getFont() const; /// - void read(Buffer const & buf, Lexer & lex); + void write(std::ostream &) const; /// - void setButtonLabel(); + void read(Lexer & lex); /// show the note dialog bool showInsetDialog(BufferView * bv) const; /// - bool isMacroScope(Buffer const & buf) const; + bool isMacroScope() const; /// - int latex(Buffer const &, odocstream &, OutputParams const &) const; + void latex(otexstream &, OutputParams const &) const; /// - int plaintext(Buffer const &, odocstream &, OutputParams const &) const; + int plaintext(odocstringstream & ods, OutputParams const & op, + size_t max_length = INT_MAX) const; /// - int docbook(Buffer const &, odocstream &, OutputParams const &) const; + int docbook(odocstream &, OutputParams const &) const; /// - void validate(LaTeXFeatures &) const; + docstring xhtml(XHTMLStream &, OutputParams const &) const; /// - InsetNoteParams const & params() const { return params_; } + void validate(LaTeXFeatures &) const; /// bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const; - // Update the counters of this inset and of its contents - virtual void updateLabels(Buffer const &, ParIterator const &); /// - void addToToc(Buffer const &, ParConstIterator const &) const; -protected: - InsetNote(InsetNote const &); + void addToToc(DocIterator const & di, bool output_active) const; /// - virtual void doDispatch(Cursor & cur, FuncRequest & cmd); -private: - friend class InsetNoteParams; - - virtual Inset * clone() const; - + void doDispatch(Cursor & cur, FuncRequest & cmd); + /// + Inset * clone() const { return new InsetNote(*this); } /// 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; + std::string contextMenuName() const; /// - static std::string const params2string(InsetNoteParams const &); - /// - static void string2params(std::string const &, InsetNoteParams &); + friend class InsetNoteParams; -private: /// - static std::string const name_; - /// - InsetNote & inset_; + InsetNoteParams params_; }; - } // namespace lyx -#endif +#endif // INSET_NOTE_H