src/insets/InsetFloatList.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetFloatList.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSET_FLOATLIST_H
  13 #define INSET_FLOATLIST_H
  14
  15
  16 #include "InsetCommand.h"
  17
  18
  19 namespace lyx {
  20
  21 /** Used to insert table of contents
  22  */
  23 class InsetFloatList : public InsetCommand {
  24 public:
  25         ///
  26         InsetFloatList(Buffer *);
  27         ///
  28         InsetFloatList(Buffer *, std::string const & type);
  29
  30         /// \name Public functions inherited from Inset class
  31         //@{
  32         ///
  33         InsetCode lyxCode() const { return FLOAT_LIST_CODE; }
  34         ///
  35         DisplayType display() const { return AlignCenter; }
  36         ///
  37         void write(std::ostream &) const;
  38         ///
  39         void read(Lexer &);
  40         ///
  41         void latex(otexstream &, OutputParams const &) const;
  42         ///
  43         int docbook(odocstream &, OutputParams const &) const { return 0; }
  44         ///
  45         int plaintext(odocstream &, OutputParams const & runparams) const;
  46         ///
  47         docstring xhtml(XHTMLStream &, OutputParams const &) const;
  48         ///
  49         void doDispatch(Cursor & cur, FuncRequest & cmd);
  50         ///
  51         bool clickable(int, int) const { return true; }
  52         ///
  53         void validate(LaTeXFeatures & features) const;
  54         //@}
  55
  56         /// \name Static public methods obligated for InsetCommand derived classes
  57         //@{
  58         ///
  59         static ParamInfo const & findInfo(std::string const &);
  60         ///
  61         static std::string defaultCommand() { return "listoftables"; }
  62         ///
  63         static bool isCompatibleCommand(std::string const & s);
  64         //@}
  65
  66 private:
  67         /// \name Private functions inherited from Inset class
  68         //@{
  69         ///
  70         Inset * clone() const { return new InsetFloatList(*this); }
  71         //@}
  72
  73         /// \name Private functions inherited from InsetCommand class
  74         //@{
  75         ///
  76         docstring screenLabel() const;
  77         //@}
  78
  79         ///
  80         static ParamInfo param_info_;
  81 };
  82
  83
  84 } // namespace lyx
  85
  86 #endif