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(Buffer const &);
  29         ///
  30         InsetCode lyxCode() const { return MARGIN_CODE; }
  31         ///
  32         docstring name() const { return from_ascii("Marginal"); }
  33         ///
  34         int latex(odocstream &, OutputParams const &) const;
  35         ///
  36         int plaintext(odocstream &, OutputParams const & runparams) const;
  37         ///
  38         int docbook(odocstream &, OutputParams const & runparams) const;
  39         ///
  40         docstring editMessage() const;
  41         ///
  42         void addToToc(ParConstIterator const &) const;
  43         ///
  44         docstring toolTip(BufferView const & bv, int x, int y) const;
  45 private:
  46         ///
  47         Inset * clone() const { return new InsetMarginal(*this); }
  48 };
  49
  50
  51 } // namespace lyx
  52
  53 #endif