InsetCommand ctor: Pass 'Buffer *'

[lyx.git] / src / Floating.h

diff --git a/src/Floating.h b/src/Floating.h
index b845ea289e45257978f2f899b6d38d6a17a09e60..6cd518bf386e82487f2d59fa0f69cb9f9a797c1a 100644 (file)
--- a/src/Floating.h
+++ b/src/Floating.h
@@ -1,36 +1,87 @@
 // -*- 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.
+ */
 class Floating {
 public:
        ///
-       string type;
+       Floating();
+       ///
+       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);
+       ///
+       std::string const & type() const;
+       ///
+       std::string const & placement() const;
+       ///
+       std::string const & ext() const;
+       ///
+       std::string const & within() const;
+       ///
+       std::string const & style() const;
        ///
-       string placement;
+       std::string const & name() const;
        ///
-       string ext;
+       std::string const & listName() const;
+       /// 
+       std::string const & htmlStyle() const;
        ///
-       string within;
+       std::string const & htmlClass() const;
        ///
-       string style;
+       std::string const & htmlType() const;
        ///
-       string name;
+       bool builtin() const;
+private:
        ///
-       bool builtin;
+       std::string type_;
+       ///
+       std::string placement_;
+       ///
+       std::string ext_;
+       ///
+       std::string within_;
+       ///
+       std::string style_;
+       ///
+       std::string name_;
+       ///
+       std::string listName_;
+       /// HTML Element type, usually div
+       std::string htmlType_;
+       /// class attribute, e.g., float-table, for CSS
+       std::string htmlClass_;
+       /// CSS information for this element
+       std::string htmlStyle_;
+       ///
+       bool builtin_;
 };
+
+
+} // namespace lyx
+
 #endif