X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetNote.h;h=e40b769854f24ca44c45c73a605a416ac2a01a86;hb=a6b07608d8e9de24383d3ebaec20b6b265ed9314;hp=303b2882bce05cca26102e4f70c8c91c98577ccb;hpb=f7b1c86393d890d5d473279d88e26bb78f8c1275;p=lyx.git diff --git a/src/insets/InsetNote.h b/src/insets/InsetNote.h index 303b2882bc..e40b769854 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" +#include "InsetCollapsible.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,80 @@ public: }; -/** The PostIt note inset, and other annotations +///////////////////////////////////////////////////////////////////////// +// +// InsetNote +// +///////////////////////////////////////////////////////////////////////// -*/ -class InsetNote : public InsetCollapsable { +/// The PostIt note inset, and other annotations +class InsetNote : public InsetCollapsible +{ 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; - /// framed and shaded notes are displayed - virtual DisplayType display() const; + docstring layoutName() const; /// - void write(Buffer const &, std::ostream &) 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; } /// - void read(Buffer const & buf, Lexer & lex); + bool allowSpellCheck() const; /// - void setButtonLabel(); + FontInfo getFont() const; + /// + void write(std::ostream &) const; + /// + void read(Lexer & lex); /// show the note dialog bool showInsetDialog(BufferView * bv) const; /// - int latex(Buffer const &, odocstream &, OutputParams const &) const; + bool isMacroScope() const; /// - int plaintext(Buffer const &, odocstream &, OutputParams const &) const; + void latex(otexstream &, OutputParams const &) const; /// - int docbook(Buffer const &, odocstream &, OutputParams const &) const; + int plaintext(odocstringstream & ods, OutputParams const & op, + size_t max_length = INT_MAX) const; /// - void validate(LaTeXFeatures &) const; + int docbook(odocstream &, OutputParams const &) const; /// - InsetNoteParams const & params() const { return params_; } + docstring xhtml(XMLStream &, OutputParams const &) const; + /// + 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 &); -protected: - InsetNote(InsetNote 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_; } + std::string contextMenuName() const; /// - virtual std::string const inset2string(Buffer const &) 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