src/Floating.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Floating.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 FLOATING_H
  13 #define FLOATING_H
  14
  15 #include <string>
  16
  17
  18 namespace lyx {
  19
  20 /** This is a "float layout" object. It contains the parameters for how to
  21  *  handle the different kinds of floats, default ones and user created ones.
  22  *  Objects of this class is stored in a container in FloatList. The different
  23  *  InsetFloat(s) have a pointer/reference through the name of the Floating
  24  *  so that it knows how the different floats should be handled.
  25  */
  26 class Floating {
  27 public:
  28         ///
  29         Floating();
  30         ///
  31         Floating(std::string const & type, std::string const & placement,
  32                  std::string const & ext, std::string const & within,
  33                  std::string const & style, std::string const & name,
  34                  std::string const & listName, bool builtin = false);
  35         ///
  36         std::string const & type() const;
  37         ///
  38         std::string const & placement() const;
  39         ///
  40         std::string const & ext() const;
  41         ///
  42         std::string const & within() const;
  43         ///
  44         std::string const & style() const;
  45         ///
  46         std::string const & name() const;
  47         ///
  48         std::string const & listName() const;
  49         ///
  50         bool builtin() const;
  51 private:
  52         ///
  53         std::string type_;
  54         ///
  55         std::string placement_;
  56         ///
  57         std::string ext_;
  58         ///
  59         std::string within_;
  60         ///
  61         std::string style_;
  62         ///
  63         std::string name_;
  64         ///
  65         std::string listName_;
  66         ///
  67         bool builtin_;
  68 };
  69
  70
  71 } // namespace lyx
  72
  73 #endif