// -*- 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>
+/** 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, bool builtin = false);
+ ///
+ std::string const & type() const;
+ ///
+ std::string const & placement() const;
+ ///
+ std::string const & ext() const;
+ ///
+ std::string const & within() const;
///
- string placement;
+ std::string const & style() const;
///
- string ext;
+ std::string const & name() const;
///
- string within;
+ std::string const & listName() const;
///
- string style;
+ bool builtin() const;
+private:
///
- string name;
+ std::string type_;
///
- bool builtin;
+ std::string placement_;
+ ///
+ std::string ext_;
+ ///
+ std::string within_;
+ ///
+ std::string style_;
+ ///
+ std::string name_;
+ ///
+ std::string listName_;
+ ///
+ bool builtin_;
};
+
#endif