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 *);
  29         ///
  30         InsetCode lyxCode() const { return MARGIN_CODE; }
  31         ///
  32         docstring layoutName() const { return from_ascii("Marginal"); }
  33         ///
  34         int plaintext(odocstringstream & ods, OutputParams const & op,
  35                       size_t max_length = INT_MAX) const;
  36         ///
  37         int docbook(odocstream &, OutputParams const & runparams) const;
  38         /// Is the content of this inset part of the immediate (visible) text sequence?
  39         bool isPartOfTextSequence() const { return false; }
  40 private:
  41         ///
  42         Inset * clone() const { return new InsetMarginal(*this); }
  43 };
  44
  45
  46 } // namespace lyx
  47
  48 #endif