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         };
  28         /// \c type defaults to Note
  29         InsetNoteParams();
  30         ///
  31         void write(std::ostream & os) const;
  32         ///
  33         void read(Lexer & lex);
  34         ///
  35         Type type;
  36 };
  37
  38
  39 /** The PostIt note inset, and other annotations
  40
  41 */
  42 class InsetNote : public InsetCollapsable {
  43 public:
  44         ///
  45         InsetNote(Buffer const &, std::string const &);
  46         ///
  47         ~InsetNote();
  48         ///
  49         InsetNoteParams const & params() const { return params_; }
  50 private:
  51         ///
  52         docstring editMessage() const;
  53         ///
  54         InsetCode lyxCode() const { return NOTE_CODE; }
  55         ///
  56         docstring name() const;
  57         ///
  58         virtual DisplayType display() const;
  59         ///
  60         void write(std::ostream &) const;
  61         ///
  62         void read(Lexer & lex);
  63         ///
  64         void setButtonLabel();
  65         /// show the note dialog
  66         bool showInsetDialog(BufferView * bv) const;
  67         ///
  68         bool isMacroScope() const;
  69         ///
  70         int latex(odocstream &, OutputParams const &) const;
  71         ///
  72         int plaintext(odocstream &, OutputParams const &) const;
  73         ///
  74         int docbook(odocstream &, OutputParams const &) const;
  75         ///
  76         void validate(LaTeXFeatures &) const;
  77         ///
  78         bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
  79         // Update the counters of this inset and of its contents
  80         void updateLabels(ParIterator const &);
  81         ///
  82         void addToToc(ParConstIterator const &) const;
  83         ///
  84         void doDispatch(Cursor & cur, FuncRequest & cmd);
  85         ///
  86         Inset * clone() const { return new InsetNote(*this); }
  87         /// used by the constructors
  88         void init();
  89         ///
  90         friend class InsetNoteParams;
  91
  92         ///
  93         InsetNoteParams params_;
  94 };
  95
  96
  97 class InsetNoteMailer : public MailInset {
  98 public:
  99         ///
 100         InsetNoteMailer(InsetNote & inset);
 101         ///
 102         virtual Inset & inset() const { return inset_; }
 103         ///
 104         virtual std::string const & name() const { return name_; }
 105         ///
 106         virtual std::string const inset2string(Buffer const &) const;
 107         ///
 108         static std::string const params2string(InsetNoteParams const &);
 109         ///
 110         static void string2params(std::string const &, InsetNoteParams &);
 111
 112 private:
 113         ///
 114         static std::string const name_;
 115         ///
 116         InsetNote & inset_;
 117 };
 118
 119
 120 } // namespace lyx
 121
 122 #endif