fix typo that put too many include paths for most people

[lyx.git] / src / Floating.h

diff --git a/src/Floating.h b/src/Floating.h
index b845ea289e45257978f2f899b6d38d6a17a09e60..2f0e5270f64e5a850bae047ed76a21536482f602 100644 (file)
--- a/src/Floating.h
+++ b/src/Floating.h
@@ -1,10 +1,10 @@
 // -*- C++ -*-
 /* This file is part of
  * ======================================================
- * 
+ *
  *           LyX, The Document Processor
  *
- *           Copyright 1998-2000 The LyX Team.
+ *           Copyright 1998-2001 The LyX Team.
  *
  * ======================================================
  */
@@ -16,21 +16,52 @@
 #pragma interface
 #endif
 
+#include "LString.h"
+
+/** 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(string const & type, string const & placement,
+                string const & ext, string const & within,
+                string const & style, string const & name,
+                bool builtin = false);
+       ///
+       string const & type() const;
+       ///
+       string const & placement() const;
+       ///
+       string const & ext() const;
        ///
-       string placement;
+       string const & within() const;
        ///
-       string ext;
+       string const & style() const;
        ///
-       string within;
+       string const & name() const;
        ///
-       string style;
+       bool builtin() const;
+private:
        ///
-       string name;
+       string type_;
        ///
-       bool builtin;
+       string placement_;
+       ///
+       string ext_;
+       ///
+       string within_;
+       ///
+       string style_;
+       ///
+       string name_;
+       ///
+       bool builtin_;
 };
+
 #endif