#ifndef FLOATING_H
#define FLOATING_H
+#include "support/strfwd.h"
+
#include <string>
namespace lyx {
-
+
/** This is a "float layout" object. It contains the parameters for how to
* handle the different kinds of floats, default ones and user created ones.
* Objects of this class is stored in a container in FloatList. The different
class Floating {
public:
///
- Floating();
+ Floating() : usesfloatpkg_(false), ispredefined_(false),
+ allowswide_(true), allowssideways_(true) {}
///
Floating(std::string const & type, std::string const & placement,
std::string const & ext, std::string const & within,
std::string const & style, std::string const & name,
std::string const & listName, std::string const & listCmd,
- std::string const & htmlType, std::string const & htmlClass,
- std::string const & htmlStyle, bool builtin = false);
+ std::string const & refPrefix, std::string const & allowedplacement,
+ std::string const & htmlType, std::string const & htmlClass,
+ docstring const & htmlStyle, bool usesfloat, bool isprefined,
+ bool allowswide, bool allowssideways);
///
std::string const & floattype() const { return floattype_; }
///
/// the title of a list of this kind of float
std::string const & listName() const { return listname_; }
/// the command used to generate that list. this has to be given
- /// if needsFloatPkg() is false. note that this should not contain
+ /// if usesFloatPkg() is false, unless this float uses the same
+ /// auxfile as another defined previously. this should not contain
/// the leading "\".
std::string const & listCommand() const { return listcommand_; }
+ /// prefix to use for formatted references to such floats
+ std::string const & refPrefix() const { return refprefix_; }
+ /// allowed placement options
+ std::string const & allowedPlacement() const { return allowedplacement_; }
+ ///
+ bool usesFloatPkg() const { return usesfloatpkg_; }
+ ///
+ bool isPredefined() const { return ispredefined_; }
///
- bool needsFloatPkg() const { return needsfloatpkg_; }
+ bool allowsWide() const { return allowswide_; }
+ ///
+ bool allowsSideways() const { return allowssideways_; }
/// style information, for preamble
- std::string const & htmlStyle() const { return html_style_; }
+ docstring const & htmlStyle() const { return html_style_; }
/// class, for css, defaults to "float-" + type()
std::string const & htmlAttrib() const;
/// tag type, defaults to "div"
///
std::string listcommand_;
///
- bool needsfloatpkg_;
- ///
+ std::string refprefix_;
+ ///
+ std::string allowedplacement_;
+ ///
+ bool usesfloatpkg_;
+ ///
+ bool ispredefined_;
+ ///
+ bool allowswide_;
+ ///
+ bool allowssideways_;
+ ///
mutable std::string html_tag_;
- ///
+ ///
mutable std::string html_attrib_;
///
mutable std::string defaultcssclass_;
- ///
- std::string html_style_;
+ ///
+ docstring html_style_;
};