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 "support/strfwd.h"
  16
  17 #include <string>
  18
  19
  20 namespace lyx {
  21
  22 /** This is a "float layout" object. It contains the parameters for how to
  23  *  handle the different kinds of floats, default ones and user created ones.
  24  *  Objects of this class is stored in a container in FloatList. The different
  25  *  InsetFloat(s) have a pointer/reference through the name of the Floating
  26  *  so that it knows how the different floats should be handled.
  27  */
  28 class Floating {
  29 public:
  30         ///
  31         Floating() : usesfloatpkg_(false), ispredefined_(false),
  32             allowswide_(true), allowssideways_(true) {}
  33         ///
  34         Floating(std::string const & type, std::string const & placement,
  35                  std::string const & ext, std::string const & within,
  36                  std::string const & style, std::string const & name,
  37                  std::string const & listName, std::string const & listCmd,
  38                  std::string const & refPrefix, std::string const & allowedplacement,
  39                  std::string const & htmlType, std::string const & htmlClass,
  40                  docstring const & htmlStyle, bool usesfloat, bool isprefined,
  41                  bool allowswide, bool allowssideways);
  42         ///
  43         std::string const & floattype() const { return floattype_; }
  44         ///
  45         std::string const & placement() const { return placement_; }
  46         ///
  47         std::string const & ext() const {return ext_; }
  48         ///
  49         std::string const & within() const { return within_; }
  50         ///
  51         std::string const & style() const { return style_; }
  52         ///
  53         std::string const & name() const { return name_; }
  54         /// the title of a list of this kind of float
  55         std::string const & listName() const { return listname_; }
  56         /// the command used to generate that list. this has to be given
  57         /// if usesFloatPkg() is false, unless this float uses the same
  58         /// auxfile as another defined previously. this should not contain
  59         /// the leading "\".
  60         std::string const & listCommand() const { return listcommand_; }
  61         /// prefix to use for formatted references to such floats
  62         std::string const & refPrefix() const { return refprefix_; }
  63         /// allowed placement options
  64         std::string const & allowedPlacement() const { return allowedplacement_; }
  65         ///
  66         bool usesFloatPkg() const { return usesfloatpkg_; }
  67         ///
  68         bool isPredefined() const { return ispredefined_; }
  69         ///
  70         bool allowsWide() const { return allowswide_; }
  71         ///
  72         bool allowsSideways() const { return allowssideways_; }
  73         /// style information, for preamble
  74         docstring const & htmlStyle() const { return html_style_; }
  75         /// class, for css, defaults to "float-" + type()
  76         std::string const & htmlAttrib() const;
  77         /// tag type, defaults to "div"
  78         std::string const & htmlTag() const;
  79 private:
  80         ///
  81         std::string defaultCSSClass() const;
  82         ///
  83         std::string floattype_;
  84         ///
  85         std::string placement_;
  86         ///
  87         std::string ext_;
  88         ///
  89         std::string within_;
  90         ///
  91         std::string style_;
  92         ///
  93         std::string name_;
  94         ///
  95         std::string listname_;
  96         ///
  97         std::string listcommand_;
  98         ///
  99         std::string refprefix_;
 100         ///
 101         std::string allowedplacement_;
 102         ///
 103         bool usesfloatpkg_;
 104         ///
 105         bool ispredefined_;
 106         ///
 107         bool  allowswide_;
 108         ///
 109         bool  allowssideways_;
 110         ///
 111         mutable std::string html_tag_;
 112         ///
 113         mutable std::string html_attrib_;
 114         ///
 115         mutable std::string defaultcssclass_;
 116         ///
 117         docstring html_style_;
 118 };
 119
 120
 121 } // namespace lyx
 122
 123 #endif