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() : usesfloatpkg_(false), ispredefined_(false) {}
  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, std::string const & allowedplacement,
  36                  std::string const & htmlType, std::string const & htmlClass,
  37                  std::string const & htmlStyle, bool usesfloat, bool isprefined);
  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 usesFloatPkg() is false, unless this float uses the same
  54         /// auxfile as another defined previously. this should not contain
  55         /// the leading "\".
  56         std::string const & listCommand() const { return listcommand_; }
  57         /// prefix to use for formatted references to such floats
  58         std::string const & refPrefix() const { return refprefix_; }
  59         /// allowed placement options
  60         std::string const & allowedPlacement() const { return allowedplacement_; }
  61         ///
  62         bool usesFloatPkg() const { return usesfloatpkg_; }
  63         ///
  64         bool isPredefined() const { return ispredefined_; }
  65         /// style information, for preamble
  66         std::string const & htmlStyle() const { return html_style_; }
  67         /// class, for css, defaults to "float-" + type()
  68         std::string const & htmlAttrib() const;
  69         /// tag type, defaults to "div"
  70         std::string const & htmlTag() const;
  71 private:
  72         ///
  73         std::string defaultCSSClass() const;
  74         ///
  75         std::string floattype_;
  76         ///
  77         std::string placement_;
  78         ///
  79         std::string ext_;
  80         ///
  81         std::string within_;
  82         ///
  83         std::string style_;
  84         ///
  85         std::string name_;
  86         ///
  87         std::string listname_;
  88         ///
  89         std::string listcommand_;
  90         ///
  91         std::string refprefix_;
  92         ///
  93         std::string allowedplacement_;
  94         ///
  95         bool usesfloatpkg_;
  96         ///
  97         bool ispredefined_;
  98         ///
  99         mutable std::string html_tag_;
 100         ///
 101         mutable std::string html_attrib_;
 102         ///
 103         mutable std::string defaultcssclass_;
 104         ///
 105         std::string html_style_;
 106 };
 107
 108
 109 } // namespace lyx
 110
 111 #endif