*
* \author Angus Leeming
*
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
*/
#ifndef INSETNOTE_H
#define INSETNOTE_H
-
#include "insetcollapsable.h"
+#include "mailinset.h"
+
-
- struct InsetNoteParams {
- ///
- void write(std::ostream & os) const;
- ///
- void read(LyXLex & lex);
- ///
- string type;
+namespace lyx {
+
+class InsetNoteParams {
+public:
+ enum Type {
+ Note,
+ Comment,
+ Greyedout,
+ Framed,
+ Shaded
+ };
+ /// \c type defaults to Note
+ InsetNoteParams();
+ ///
+ void write(std::ostream & os) const;
+ ///
+ void read(LyXLex & lex);
+ ///
+ Type type;
};
-
-
+
+
/** The PostIt note inset, and other annotations
*/
class InsetNote : public InsetCollapsable {
public:
///
-
-
- InsetNote(BufferParams const &, string const &);
- /// Copy constructor
- InsetNote(InsetNote const &);
+ InsetNote(BufferParams const &, std::string const &);
///
~InsetNote();
///
- InsetBase * clone() const;
- ///
- string const editMessage() const;
+ virtual docstring const editMessage() const;
///
- Inset::Code lyxCode() const { return Inset::NOTE_CODE; }
+ InsetBase::Code lyxCode() const { return InsetBase::NOTE_CODE; }
///
- void write(Buffer const *, std::ostream &) const;
+ void write(Buffer const &, std::ostream &) const;
///
- void read(Buffer const * buf, LyXLex & lex);
+ void read(Buffer const & buf, LyXLex & lex);
///
void setButtonLabel();
- ///
- dispatch_result InsetNote::localDispatch(FuncRequest const &);
/// show the note dialog
bool showInsetDialog(BufferView * bv) const;
///
- int latex(Buffer const *, std::ostream &,
- LatexRunParams const &) const;
+ int latex(Buffer const &, odocstream &, OutputParams const &) const;
///
- int linuxdoc(Buffer const *, std::ostream &) const;
+ int docbook(Buffer const &, odocstream &, OutputParams const &) const;
///
- int docbook(Buffer const *, std::ostream &, bool) const;
- ///
- int ascii(Buffer const *, std::ostream &, int) const;
+ int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
///
void validate(LaTeXFeatures &) const;
///
InsetNoteParams const & params() const { return params_; }
-
+ ///
+ bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
+protected:
+ InsetNote(InsetNote const &);
+ ///
+ virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
private:
friend class InsetNoteParams;
+ virtual std::auto_ptr<InsetBase> doClone() const;
+
/// used by the constructors
void init();
///
InsetNoteParams params_;
};
-#include "mailinset.h"
class InsetNoteMailer : public MailInset {
public:
///
- InsetNoteMailer(string const & name, InsetNote & inset);
+ InsetNoteMailer(InsetNote & inset);
///
virtual InsetBase & inset() const { return inset_; }
///
- virtual string const & name() const { return name_; }
+ virtual std::string const & name() const { return name_; }
///
- virtual string const inset2string(Buffer const &) const;
+ virtual std::string const inset2string(Buffer const &) const;
///
- static string const params2string(string const &, InsetNoteParams const &);
+ static std::string const params2string(InsetNoteParams const &);
///
- static void string2params(string const &, InsetNoteParams &);
+ static void string2params(std::string const &, InsetNoteParams &);
private:
///
- string const name_;
+ static std::string const name_;
///
InsetNote & inset_;
};
+} // namespace lyx
#endif