4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
9 * Full author contact details are available in file CREDITS.
15 #include "support/strfwd.h"
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.
31 Floating() : usesfloatpkg_(false), ispredefined_(false),
32 allowswide_(true), allowssideways_(true) {}
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, std::string const & docbookTag,
41 std::string const & docbookAttr, std::string const & required,
42 bool usesfloat, bool isprefined, bool allowswide, bool allowssideways);
44 std::string const & floattype() const { return floattype_; }
46 std::string const & placement() const { return placement_; }
48 std::string const & ext() const {return ext_; }
50 std::string const & within() const { return within_; }
52 std::string const & style() const { return style_; }
54 std::string const & name() const { return name_; }
55 /// the title of a list of this kind of float
56 std::string const & listName() const { return listname_; }
57 /// the command used to generate that list. this has to be given
58 /// if usesFloatPkg() is false, unless this float uses the same
59 /// auxfile as another defined previously. this should not contain
61 std::string const & listCommand() const { return listcommand_; }
62 /// prefix to use for formatted references to such floats
63 std::string const & refPrefix() const { return refprefix_; }
64 /// allowed placement options
65 std::string const & allowedPlacement() const { return allowedplacement_; }
67 bool usesFloatPkg() const { return usesfloatpkg_; }
68 /// allowed placement options
69 std::string const & required() const { return required_; }
71 bool isPredefined() const { return ispredefined_; }
73 bool allowsWide() const { return allowswide_; }
75 bool allowsSideways() const { return allowssideways_; }
76 /// style information, for preamble
77 docstring const & htmlStyle() const { return html_style_; }
78 /// class, for css, defaults to "float-" + type()
79 std::string const & htmlAttrib() const;
80 /// tag type, defaults to "div"
81 std::string const & htmlTag() const;
83 std::string const & docbookTag(bool hasTitle = false) const;
85 std::string const & docbookAttr() const;
87 std::string const & docbookCaption() const;
90 std::string defaultCSSClass() const;
92 std::string floattype_;
94 std::string placement_;
104 std::string listname_;
106 std::string listcommand_;
108 std::string refprefix_;
110 std::string allowedplacement_;
112 std::string required_;
120 bool allowssideways_;
122 mutable std::string html_tag_;
124 mutable std::string html_attrib_;
126 mutable std::string defaultcssclass_;
128 docstring html_style_;
130 mutable std::string docbook_tag_;
131 /// attribute (mostly, role)
132 mutable std::string docbook_caption_;
133 /// caption tag (mostly, either caption or title)
134 std::string docbook_attr_;