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.
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.
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,
36 std::string const & htmlType, std::string const & htmlClass,
37 std::string const & htmlStyle, bool usesfloat, bool isprefined);
39 std::string const & floattype() const { return floattype_; }
41 std::string const & placement() const { return placement_; }
43 std::string const & ext() const {return ext_; }
45 std::string const & within() const { return within_; }
47 std::string const & style() const { return style_; }
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
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_; }
60 bool usesFloatPkg() const { return usesfloatpkg_; }
62 bool isPredefined() const { return ispredefined_; }
63 /// style information, for preamble
64 std::string const & htmlStyle() const { return html_style_; }
65 /// class, for css, defaults to "float-" + type()
66 std::string const & htmlAttrib() const;
67 /// tag type, defaults to "div"
68 std::string const & htmlTag() const;
71 std::string defaultCSSClass() const;
73 std::string floattype_;
75 std::string placement_;
85 std::string listname_;
87 std::string listcommand_;
89 std::string refprefix_;
95 mutable std::string html_tag_;
97 mutable std::string html_attrib_;
99 mutable std::string defaultcssclass_;
101 std::string html_style_;