#ifndef FLOATING_H
#define FLOATING_H
+#include "support/strfwd.h"
+
#include <string>
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 & htmlType,
- std::string const & htmlClass, std::string const & htmlStyle,
- bool builtin = false);
+ std::string const & listName, std::string const & listCmd,
+ std::string const & refPrefix, std::string const & allowedplacement,
+ std::string const & htmlType, std::string const & htmlClass,
+ docstring const & htmlStyle, std::string const & docbookTag,
+ std::string const & docbookAttr, std::string const & required,
+ bool usesfloat, bool isprefined, bool allowswide, bool allowssideways);
+ ///
+ std::string const & floattype() const { return floattype_; }
+ ///
+ std::string const & placement() const { return placement_; }
///
- std::string const & type() const;
+ std::string const & ext() const {return ext_; }
///
- std::string const & placement() const;
+ std::string const & within() const { return within_; }
///
- std::string const & ext() const;
+ std::string const & style() const { return style_; }
///
- std::string const & within() const;
+ std::string const & name() const { return name_; }
+ /// 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 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_; }
///
- std::string const & style() const;
+ bool usesFloatPkg() const { return usesfloatpkg_; }
+ /// allowed placement options
+ std::string const & required() const { return required_; }
///
- std::string const & name() const;
+ bool isPredefined() const { return ispredefined_; }
///
- std::string const & listName() const;
+ bool allowsWide() const { return allowswide_; }
+ ///
+ bool allowsSideways() const { return allowssideways_; }
/// style information, for preamble
- std::string const & htmlStyle() const;
+ docstring const & htmlStyle() const { return html_style_; }
/// class, for css, defaults to "float-" + type()
- std::string const & htmlClass() const;
+ std::string const & htmlAttrib() const;
/// tag type, defaults to "div"
std::string const & htmlTag() const;
///
- bool builtin() const;
+ std::string const & docbookTag(bool hasTitle = false) const;
+ ///
+ std::string const & docbookAttr() const;
+ ///
+ std::string const & docbookCaption() const;
private:
///
- std::string type_;
+ std::string defaultCSSClass() const;
+ ///
+ std::string floattype_;
///
std::string placement_;
///
///
std::string name_;
///
- std::string listName_;
- ///
+ std::string listname_;
+ ///
+ std::string listcommand_;
+ ///
+ std::string refprefix_;
+ ///
+ std::string allowedplacement_;
+ ///
+ std::string required_;
+ ///
+ bool usesfloatpkg_;
+ ///
+ bool ispredefined_;
+ ///
+ bool allowswide_;
+ ///
+ bool allowssideways_;
+ ///
mutable std::string html_tag_;
- ///
- mutable std::string html_class_;
- ///
- std::string html_style_;
///
- bool builtin_;
+ mutable std::string html_attrib_;
+ ///
+ mutable std::string defaultcssclass_;
+ ///
+ docstring html_style_;
+ /// DocBook tag
+ mutable std::string docbook_tag_;
+ /// attribute (mostly, role)
+ mutable std::string docbook_caption_;
+ /// caption tag (mostly, either caption or title)
+ std::string docbook_attr_;
};