4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
9 * Full author contact details are available in file CREDITS
16 #include "insetcollapsable.h"
19 struct InsetNoteParams {
21 void write(std::ostream & os) const;
23 void read(LyXLex & lex);
29 /** The PostIt note inset, and other annotations
32 class InsetNote : public InsetCollapsable {
37 InsetNote(BufferParams const &, string const &);
39 InsetNote(InsetNote const &);
43 InsetBase * clone() const;
45 string const editMessage() const;
47 Inset::Code lyxCode() const { return Inset::NOTE_CODE; }
49 void write(Buffer const *, std::ostream &) const;
51 void read(Buffer const * buf, LyXLex & lex);
53 void setButtonLabel();
55 dispatch_result InsetNote::localDispatch(FuncRequest const &);
56 /// show the note dialog
57 bool showInsetDialog(BufferView * bv) const;
59 int latex(Buffer const *, std::ostream &,
60 LatexRunParams const &) const;
62 int linuxdoc(Buffer const *, std::ostream &) const;
64 int docbook(Buffer const *, std::ostream &, bool) const;
66 int ascii(Buffer const *, std::ostream &, int) const;
68 void validate(LaTeXFeatures &) const;
70 InsetNoteParams const & params() const { return params_; }
73 friend class InsetNoteParams;
75 /// used by the constructors
78 InsetNoteParams params_;
81 #include "mailinset.h"
83 class InsetNoteMailer : public MailInset {
86 InsetNoteMailer(string const & name, InsetNote & inset);
88 virtual InsetBase & inset() const { return inset_; }
90 virtual string const & name() const { return name_; }
92 virtual string const inset2string(Buffer const &) const;
94 static string const params2string(string const &, InsetNoteParams const &);
96 static void string2params(string const &, InsetNoteParams &);