X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FFloating.h;h=d50fa90870e8b86d5a3eb895f243e2f3e53df84e;hb=c99a8a702c285bbc961171d402dcffb458a12c0c;hp=372bda9774f14000fcb92dafc9118dd5051507ba;hpb=0be0fcfd5907d448cd51addf83ed7032719a0692;p=lyx.git diff --git a/src/Floating.h b/src/Floating.h index 372bda9774..d50fa90870 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. */ @@ -12,56 +12,91 @@ #ifndef FLOATING_H #define FLOATING_H -#include "LString.h" +#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(string const & type, string const & placement, - string const & ext, string const & within, - string const & style, string const & name, - string const & listName, bool builtin = false); - /// - string const & type() const; - /// - string const & placement() const; - /// - string const & ext() const; - /// - string const & within() const; + 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 & refPrefix, + std::string const & htmlType, std::string const & htmlClass, + std::string const & htmlStyle, bool builtin = false); + /// + std::string const & floattype() const { return floattype_; } + /// + std::string const & placement() const { return placement_; } + /// + std::string const & ext() const {return ext_; } + /// + std::string const & within() const { return within_; } + /// + std::string const & style() const { return style_; } + /// + 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 needsFloatPkg() is false. note that 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_; } + /// + bool needsFloatPkg() const { return needsfloatpkg_; } + /// 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: /// - string const & style() const; + std::string defaultCSSClass() const; /// - string const & name() const; + std::string floattype_; /// - string const & listName() const; + std::string placement_; /// - bool builtin() const; -private: + std::string ext_; /// - string type_; + std::string within_; /// - string placement_; + std::string style_; /// - string ext_; + std::string name_; /// - string within_; + std::string listname_; /// - string style_; + std::string listcommand_; /// - string name_; + std::string refprefix_; /// - string listName_; + bool needsfloatpkg_; + /// + mutable std::string html_tag_; + /// + mutable std::string html_attrib_; /// - bool builtin_; + mutable std::string defaultcssclass_; + /// + std::string html_style_; }; + +} // namespace lyx + #endif