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
  16 #include "insetcollapsable.h"
  17
  18
  19  struct InsetNoteParams {
  20         ///
  21         void write(std::ostream & os) const;
  22         ///
  23         void read(LyXLex & lex);
  24         ///
  25         string type;
  26 };
  27
  28
  29 /** The PostIt note inset, and other annotations
  30
  31 */
  32 class InsetNote : public InsetCollapsable {
  33 public:
  34         ///
  35
  36
  37         InsetNote(BufferParams const &, string const &);
  38         /// Copy constructor
  39         InsetNote(InsetNote const &);
  40         ///
  41         ~InsetNote();
  42         ///
  43         virtual std::auto_ptr<InsetBase> clone() const;
  44         ///
  45         string const editMessage() const;
  46         ///
  47         InsetOld::Code lyxCode() const { return InsetOld::NOTE_CODE; }
  48         ///
  49         void write(Buffer const *, std::ostream &) const;
  50         ///
  51         void read(Buffer const * buf, LyXLex & lex);
  52         ///
  53         void setButtonLabel();
  54         ///
  55         dispatch_result InsetNote::localDispatch(FuncRequest const &);
  56         ///
  57         void metrics(MetricsInfo &, Dimension &) const;
  58         /// show the note dialog
  59         bool showInsetDialog(BufferView * bv) const;
  60         ///
  61         int latex(Buffer const *, std::ostream &,
  62                         LatexRunParams const &) const;
  63         ///
  64         int linuxdoc(Buffer const *, std::ostream &) const;
  65         ///
  66         int docbook(Buffer const *, std::ostream &, bool) const;
  67         ///
  68         int ascii(Buffer const *, std::ostream &, int) const;
  69         ///
  70         void validate(LaTeXFeatures &) const;
  71         ///
  72         InsetNoteParams const & params() const { return params_; }
  73
  74 private:
  75         friend class InsetNoteParams;
  76
  77         /// used by the constructors
  78         void init();
  79         ///
  80         InsetNoteParams params_;
  81 };
  82
  83 #include "mailinset.h"
  84
  85 class InsetNoteMailer : public MailInset {
  86 public:
  87         ///
  88         InsetNoteMailer(string const & name, InsetNote & inset);
  89         ///
  90         virtual InsetBase & inset() const { return inset_; }
  91         ///
  92         virtual string const & name() const { return name_; }
  93         ///
  94         virtual string const inset2string(Buffer const &) const;
  95         ///
  96         static string const params2string(string const &, InsetNoteParams const &);
  97         ///
  98         static void string2params(string const &, InsetNoteParams &);
  99
 100 private:
 101         ///
 102         string const name_;
 103         ///
 104         InsetNote & inset_;
 105 };
 106
 107
 108
 109 #endif