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, std::string const & listCmd,
  35                  std::string const & refPrefix,
  36                  std::string const & htmlType, std::string const & htmlClass,
  37                  std::string const & htmlStyle, bool builtin = false);
  38         ///
  39         std::string const & floattype() const { return floattype_; }
  40         ///
  41         std::string const & placement() const { return placement_; }
  42         ///
  43         std::string const & ext() const {return ext_; }
  44         ///
  45         std::string const & within() const { return within_; }
  46         ///
  47         std::string const & style() const { return style_; }
  48         ///
  49         std::string const & name() const { return name_; }
  50         /// the title of a list of this kind of float
  51         std::string const & listName() const { return listname_; }
  52         /// the command used to generate that list. this has to be given
  53         /// if needsFloatPkg() is false. note that this should not contain
  54         /// the leading "\".
  55         std::string const & listCommand() const { return listcommand_; }
  56         /// prefix to use for formatted references to such floats
  57         std::string const & refPrefix() const { return refprefix_; }
  58         ///
  59         bool needsFloatPkg() const { return needsfloatpkg_; }
  60         /// style information, for preamble
  61         std::string const & htmlStyle() const { return html_style_; }
  62         /// class, for css, defaults to "float-" + type()
  63         std::string const & htmlAttrib() const;
  64         /// tag type, defaults to "div"
  65         std::string const & htmlTag() const;
  66 private:
  67         ///
  68         std::string defaultCSSClass() const;
  69         ///
  70         std::string floattype_;
  71         ///
  72         std::string placement_;
  73         ///
  74         std::string ext_;
  75         ///
  76         std::string within_;
  77         ///
  78         std::string style_;
  79         ///
  80         std::string name_;
  81         ///
  82         std::string listname_;
  83         ///
  84         std::string listcommand_;
  85         ///
  86         std::string refprefix_;
  87         ///
  88         bool needsfloatpkg_;
  89         ///
  90         mutable std::string html_tag_;
  91         ///
  92         mutable std::string html_attrib_;
  93         ///
  94         mutable std::string defaultcssclass_;
  95         ///
  96         std::string html_style_;
  97 };
  98
  99
 100 } // namespace lyx
 101
 102 #endif