X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetNote.h;h=dd580da8a024b8895e1a8933bfddb3bab8df7e4a;hb=9b530e59c2b74828f3a68f3bb7ee3dee0365cdc0;hp=0cb7313305276614e6f2b4880847b0b8b3be5551;hpb=ed858d73e57ce7aa89e38c1bc4d799362edb0227;p=lyx.git diff --git a/src/insets/InsetNote.h b/src/insets/InsetNote.h index 0cb7313305..dd580da8a0 100644 --- a/src/insets/InsetNote.h +++ b/src/insets/InsetNote.h @@ -9,23 +9,21 @@ * 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, Comment, - Greyedout, - Framed, - Shaded + Greyedout }; /// \c type defaults to Note InsetNoteParams(); @@ -38,84 +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 &); /// - Inset::Code lyxCode() const { return Inset::NOTE_CODE; } + static void string2params(std::string const &, InsetNoteParams &); /// - docstring name() const; - /// framed and shaded notes are displayed - virtual DisplayType display() const; + InsetNoteParams const & params() const { return params_; } +private: /// - void write(Buffer const &, std::ostream &) const; + InsetCode lyxCode() const { return NOTE_CODE; } /// - void read(Buffer const & buf, Lexer & lex); + docstring layoutName() const; /// - void setButtonLabel(); - /// show the note dialog - bool showInsetDialog(BufferView * bv) 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; } /// - int latex(Buffer const &, odocstream &, OutputParams const &) const; + bool allowSpellCheck() const; /// - int plaintext(Buffer const &, odocstream &, OutputParams const &) const; + FontInfo getFont() const; /// - int docbook(Buffer const &, odocstream &, OutputParams const &) const; + void write(std::ostream &) const; /// - void validate(LaTeXFeatures &) const; + void read(Lexer & lex); + /// show the note dialog + bool showInsetDialog(BufferView * bv) const; /// - InsetNoteParams const & params() const { return params_; } + bool isMacroScope() 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 &); -protected: - InsetNote(InsetNote const &); + void latex(otexstream &, OutputParams const &) const; /// - virtual void doDispatch(Cursor & cur, FuncRequest & cmd); -private: - friend class InsetNoteParams; - - virtual Inset * clone() const; - - /// used by the constructors - void init(); + int plaintext(odocstringstream & ods, OutputParams const & op, + size_t max_length = INT_MAX) const; /// - InsetNoteParams params_; -}; - - -class InsetNoteMailer : public MailInset { -public: + int docbook(odocstream &, OutputParams const &) const; /// - InsetNoteMailer(InsetNote & inset); + docstring xhtml(XHTMLStream &, OutputParams const &) const; /// - virtual Inset & inset() const { return inset_; } + void validate(LaTeXFeatures &) const; /// - virtual std::string const & name() const { return name_; } + bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const; /// - virtual std::string const inset2string(Buffer const &) const; + void addToToc(DocIterator const & di, bool output_active) const; /// - static std::string const params2string(InsetNoteParams const &); + void doDispatch(Cursor & cur, FuncRequest & cmd); /// - static void string2params(std::string const &, InsetNoteParams &); - -private: + Inset * clone() const { return new InsetNote(*this); } + /// used by the constructors + void init(); /// - static std::string const name_; + std::string contextMenuName() const; /// - InsetNote & inset_; -}; + friend class InsetNoteParams; + /// + InsetNoteParams params_; +}; } // namespace lyx -#endif +#endif // INSET_NOTE_H