src/insets/InsetNote.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetNote.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Angus Leeming
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSETNOTE_H
  13 #define INSETNOTE_H
  14
  15 #include "InsetCollapsable.h"
  16 #include "MailInset.h"
  17
  18
  19 namespace lyx {
  20
  21 class InsetNoteParams {
  22 public:
  23         enum Type {
  24                 Note,
  25                 Comment,
  26                 Greyedout,
  27                 Framed,
  28                 Shaded
  29         };
  30         /// \c type defaults to Note
  31         InsetNoteParams();
  32         ///
  33         void write(std::ostream & os) const;
  34         ///
  35         void read(Lexer & lex);
  36         ///
  37         Type type;
  38 };
  39
  40
  41 /** The PostIt note inset, and other annotations
  42
  43 */
  44 class InsetNote : public InsetCollapsable {
  45 public:
  46         ///
  47         InsetNote(BufferParams const &, std::string const &);
  48         ///
  49         ~InsetNote();
  50         ///
  51         virtual docstring const editMessage() const;
  52         ///
  53         Inset::Code lyxCode() const { return Inset::NOTE_CODE; }
  54         ///
  55         docstring insetName() const { return from_ascii("Note"); }
  56         ///
  57         void write(Buffer const &, std::ostream &) const;
  58         ///
  59         void read(Buffer const & buf, Lexer & lex);
  60         ///
  61         void setButtonLabel();
  62         /// show the note dialog
  63         bool showInsetDialog(BufferView * bv) const;
  64         ///
  65         int latex(Buffer const &, odocstream &, OutputParams const &) const;
  66         ///
  67         int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
  68         ///
  69         int docbook(Buffer const &, odocstream &, OutputParams const &) const;
  70         ///
  71         void validate(LaTeXFeatures &) const;
  72         ///
  73         InsetNoteParams const & params() const { return params_; }
  74         ///
  75         bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
  76 protected:
  77         InsetNote(InsetNote const &);
  78         ///
  79         virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
  80 private:
  81         friend class InsetNoteParams;
  82
  83         virtual std::auto_ptr<Inset> doClone() const;
  84
  85         /// used by the constructors
  86         void init();
  87         ///
  88         InsetNoteParams params_;
  89 };
  90
  91
  92 class InsetNoteMailer : public MailInset {
  93 public:
  94         ///
  95         InsetNoteMailer(InsetNote & inset);
  96         ///
  97         virtual Inset & inset() const { return inset_; }
  98         ///
  99         virtual std::string const & name() const { return name_; }
 100         ///
 101         virtual std::string const inset2string(Buffer const &) const;
 102         ///
 103         static std::string const params2string(InsetNoteParams const &);
 104         ///
 105         static void string2params(std::string const &, InsetNoteParams &);
 106
 107 private:
 108         ///
 109         static std::string const name_;
 110         ///
 111         InsetNote & inset_;
 112 };
 113
 114
 115 } // namespace lyx
 116
 117 #endif