src/insets/InsetMarginal.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetMarginal.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Jürgen Vigna
   8  * \author Lars Gullik Bjønnes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef INSETMARGINAL_H
  14 #define INSETMARGINAL_H
  15
  16
  17 #include "InsetFootlike.h"
  18
  19
  20 namespace lyx {
  21
  22 /** The marginal note inset
  23
  24 */
  25 class InsetMarginal : public InsetFootlike {
  26 public:
  27         ///
  28         InsetMarginal(BufferParams const &);
  29         ///
  30         Inset::Code lyxCode() const { return Inset::MARGIN_CODE; }
  31         ///
  32         docstring name() const { return from_ascii("Marginal"); }
  33         ///
  34         int latex(Buffer const &, odocstream &,
  35                   OutputParams const &) const;
  36         ///
  37         int plaintext(Buffer const &, odocstream &,
  38                       OutputParams const & runparams) const;
  39         ///
  40         int docbook(Buffer const &, odocstream &,
  41                     OutputParams const & runparams) const;
  42         ///
  43         virtual docstring const editMessage() const;
  44 protected:
  45         InsetMarginal(InsetMarginal const &);
  46 private:
  47         virtual std::auto_ptr<Inset> doClone() const;
  48 };
  49
  50
  51 } // namespace lyx
  52
  53 #endif