X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FFloating.h;h=d0a51a08d183de99aae70e055c04015fc60e3d7d;hb=68ee68103a77300c3aa01db9e63bd01b8243a0eb;hp=51c3dfb170cb00e504ca7faf4092c10e19ded38d;hpb=44cd0fc9a1687cc63911c7f98d978594458e7813;p=lyx.git diff --git a/src/Floating.h b/src/Floating.h index 51c3dfb170..d0a51a08d1 100644 --- a/src/Floating.h +++ b/src/Floating.h @@ -4,7 +4,7 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes * * Full author contact details are available in file CREDITS. */ @@ -14,40 +14,63 @@ #include + +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 - InsetFloat(s) have a pointer/reference through the name of the Floating - so that it knows how the different floats should be handled. -*/ + * 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 + * InsetFloat(s) have a pointer/reference through the name of the Floating + * so that it knows how the different floats should be handled. + */ class Floating { public: /// - Floating(); + Floating() : usesfloatpkg_(false), ispredefined_(false) {} /// 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, bool builtin = false); + std::string const & listName, std::string const & listCmd, + std::string const & refPrefix, + std::string const & htmlType, std::string const & htmlClass, + std::string const & htmlStyle, bool usesfloat, bool isprefined); /// - std::string const & type() const; + std::string const & floattype() const { return floattype_; } /// - std::string const & placement() const; + std::string const & placement() const { return placement_; } /// - std::string const & ext() const; + std::string const & ext() const {return ext_; } /// - std::string const & within() const; + std::string const & within() const { return within_; } /// - std::string const & style() const; + std::string const & style() const { return style_; } /// - std::string const & name() 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_; } /// - std::string const & listName() const; + bool usesFloatPkg() const { return usesfloatpkg_; } /// - bool builtin() const; + bool isPredefined() const { return ispredefined_; } + /// style information, for preamble + std::string 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 const & htmlTag() const; private: /// - std::string type_; + std::string defaultCSSClass() const; + /// + std::string floattype_; /// std::string placement_; /// @@ -59,9 +82,26 @@ private: /// std::string name_; /// - std::string listName_; + std::string listname_; + /// + std::string listcommand_; + /// + std::string refprefix_; /// - bool builtin_; + bool usesfloatpkg_; + /// + bool ispredefined_; + /// + mutable std::string html_tag_; + /// + mutable std::string html_attrib_; + /// + mutable std::string defaultcssclass_; + /// + std::string html_style_; }; + +} // namespace lyx + #endif