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 #ifdef __GNUG__
  16 #pragma interface
  17 #endif
  18
  19 #include "insetcollapsable.h"
  20
  21 /** The PostIt note inset
  22
  23 */
  24 class InsetNote : public InsetCollapsable {
  25 public:
  26         ///
  27         InsetNote(BufferParams const &);
  28         ///
  29         InsetNote(InsetNote const &, bool same_id = false);
  30         ///
  31         Inset * clone(Buffer const &, bool same_id = false) const;
  32         /// constructor with initial contents
  33         InsetNote(Buffer const *, string const & contents, bool collapsed);
  34         ///
  35         string const editMessage() const;
  36         ///
  37         Inset::Code lyxCode() const { return Inset::NOTE_CODE; }
  38         ///
  39         void write(Buffer const *, std::ostream &) const;
  40         ///
  41         int latex(Buffer const *, std::ostream &, bool, bool) const
  42                 { return 0; }
  43         ///
  44         int linuxdoc(Buffer const *, std::ostream &) const
  45                 { return 0; }
  46         ///
  47         int docbook(Buffer const *, std::ostream &, bool) const
  48                 { return 0; }
  49         ///
  50         int ascii(Buffer const *, std::ostream &, int) const
  51                 { return 0; }
  52         ///
  53         void validate(LaTeXFeatures &) const {}
  54 private:
  55         /// used by the constructors
  56         void init();
  57
  58 };
  59
  60 #endif