// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
+/**
+ * \file Floating.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * Copyright 1998-2000 The LyX Team.
+ * \author Lars Gullik Bjønnes
*
- * ======================================================
+ * Full author contact details are available in file CREDITS.
*/
#ifndef FLOATING_H
#define FLOATING_H
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include <string>
+
+
+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,
+ 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);
///
- string const & type() const;
+ std::string const & type() const;
+ ///
+ std::string const & placement() const;
///
- string const & placement() const;
+ std::string const & ext() const;
///
- string const & name() const;
+ std::string const & within() const;
+ ///
+ std::string const & style() const;
+ ///
+ std::string const & name() const;
+ ///
+ std::string const & listName() const;
+ /// style information, for preamble
+ std::string const & htmlStyle() const;
+ /// class, for css, defaults to "float-" + type()
+ std::string const & htmlClass() const;
+ /// tag type, defaults to "div"
+ std::string const & htmlTag() const;
///
bool builtin() const;
private:
///
- string type_;
+ std::string type_;
///
- string placement_;
+ std::string placement_;
///
- string ext_;
+ std::string ext_;
///
- string within_;
+ std::string within_;
///
- string style_;
+ std::string style_;
///
- string name_;
+ std::string name_;
+ ///
+ std::string listName_;
+ ///
+ mutable std::string html_tag_;
+ ///
+ mutable std::string html_class_;
+ ///
+ std::string html_style_;
///
bool builtin_;
};
-inline
-Floating::Floating()
-{}
-
-
-inline
-Floating::Floating(string const & type, string const & placement,
- string const & ext, string const & within,
- string const & style, string const & name,
- bool builtin)
- : type_(type), placement_(placement), ext_(ext), within_(within),
- style_(style), name_(name), builtin_(builtin)
-{}
-
-
-inline
-string const & Floating::type() const
-{
- return type_;
-}
-
-
-inline
-string const & Floating::placement() const
-{
- return placement_;
-}
-
-
-inline
-string const & Floating::name() const
-{
- return name_;
-}
-
-
-inline
-bool Floating::builtin() const
-{
- return builtin_;
-}
+} // namespace lyx
#endif