src/insets/InsetFoot.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetFoot.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 INSETFOOT_H
  14 #define INSETFOOT_H
  15
  16 #include "InsetFootlike.h"
  17
  18
  19 namespace lyx {
  20
  21 /** The footnote inset
  22
  23 */
  24 class InsetFoot : public InsetFootlike {
  25 public:
  26         ///
  27         InsetFoot(BufferParams const &);
  28         ///
  29         InsetCode lyxCode() const { return FOOT_CODE; }
  30         ///
  31         docstring name() const { return from_ascii("Foot"); }
  32         ///
  33         int latex(Buffer const &, odocstream &,
  34                   OutputParams const &) const;
  35         ///
  36         int plaintext(Buffer const &, odocstream &,
  37                       OutputParams const &) const;
  38         ///
  39         int docbook(Buffer const &, odocstream &,
  40                     OutputParams const &) const;
  41         ///
  42         virtual docstring const editMessage() const;
  43         /// Update the counters of this inset and of its contents
  44         void updateLabels(Buffer const &, ParIterator const &);
  45         ///
  46         void addToToc(Buffer const &, ParConstIterator const &) const;
  47
  48 protected:
  49         InsetFoot(InsetFoot const &);
  50 private:
  51         virtual Inset * clone() const;
  52 };
  53
  54
  55 } // namespace lyx
  56
  57 #endif