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