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         explicit 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(odocstringstream & ods, OutputParams const & op,
  46                       size_t max_length = INT_MAX) const;
  47         ///
  48         docstring xhtml(XHTMLStream &, OutputParams const &) const;
  49         ///
  50         void doDispatch(Cursor & cur, FuncRequest & cmd);
  51         ///
  52         bool clickable(BufferView const &, int, int) const { return true; }
  53         ///
  54         void validate(LaTeXFeatures & features) const;
  55         //@}
  56
  57         /// \name Static public methods obligated for InsetCommand derived classes
  58         //@{
  59         ///
  60         static ParamInfo const & findInfo(std::string const &);
  61         ///
  62         static std::string defaultCommand() { return "listoftables"; }
  63         ///
  64         static bool isCompatibleCommand(std::string const & s);
  65         //@}
  66
  67 private:
  68         /// \name Private functions inherited from Inset class
  69         //@{
  70         ///
  71         Inset * clone() const { return new InsetFloatList(*this); }
  72         ///
  73         docstring layoutName() const;
  74         //@}
  75
  76         /// \name Private functions inherited from InsetCommand class
  77         //@{
  78         ///
  79         docstring screenLabel() const;
  80         //@}
  81 };
  82
  83
  84 } // namespace lyx
  85
  86 #endif