summaryrefslogtreecommitdiffstats
path: root/kig/kig/kig_document.h
diff options
context:
space:
mode:
Diffstat (limited to 'kig/kig/kig_document.h')
-rw-r--r--kig/kig/kig_document.h137
1 files changed, 137 insertions, 0 deletions
diff --git a/kig/kig/kig_document.h b/kig/kig/kig_document.h
new file mode 100644
index 00000000..6bcdb623
--- /dev/null
+++ b/kig/kig/kig_document.h
@@ -0,0 +1,137 @@
+// Copyright (C) 2004 Dominique Devriese <devriese@kde.org>
+
+// This program is free software; you can redistribute it and/or
+// modify it under the terms of the GNU General Public License
+// as published by the Free Software Foundation; either version 2
+// of the License, or (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+// 02110-1301, USA.
+
+#ifndef KIG_KIG_KIG_DOCUMENT_H
+#define KIG_KIG_KIG_DOCUMENT_H
+
+#include <set>
+#include <vector>
+
+class Coordinate;
+class CoordinateSystem;
+class KigWidget;
+class ObjectHolder;
+class Rect;
+
+/**
+ * KigDocument is the class holding the real data in a Kig document.
+ * It owns a set of Objects, and a CoordinateSystem, which comprise
+ * the entire content of a Kig document.
+ */
+class KigDocument {
+ /**
+ * Here we keep the objects in the document. These are only the
+ * objects that the user is aware of. Other objects exist as well,
+ * but there's no ObjectHolder for them, and they only exist because
+ * some other ObjectCalcer has them as its ancestor.
+ */
+ std::set<ObjectHolder*> mobjects;
+
+ /**
+ * The CoordinateSystem as the user sees it: this has little to do
+ * with the internal coordinates of the objects... It really serves
+ * to translate user coordinates from and to internal coordinates.
+ */
+ CoordinateSystem* mcoordsystem;
+ /**
+ * Whether to show the grid.
+ */
+ bool mshowgrid;
+ /**
+ * Whether to show the axes.
+ */
+ bool mshowaxes;
+ /**
+ * Whether to enable visibility of hidden objects.
+ */
+ bool mnightvision;
+public:
+ KigDocument();
+ KigDocument( std::set<ObjectHolder*> objects, CoordinateSystem* coordsystem,
+ bool showgrid = true, bool showaxes = true, bool nv = false );
+ ~KigDocument();
+
+ const CoordinateSystem& coordinateSystem() const;
+ const bool grid() const;
+ const bool axes() const;
+ const bool getNightVision() const;
+ /**
+ * Get a hold of the objects of this KigDocument.
+ */
+ const std::vector<ObjectHolder*> objects() const;
+ const std::set<ObjectHolder*>& objectsSet() const;
+
+ /**
+ * sets the coordinate system to \p s , and returns the old one..
+ */
+ CoordinateSystem* switchCoordinateSystem( CoordinateSystem* s );
+
+ /**
+ * sets the coordinate system to \p s , and deletes the old one..
+ */
+ void setCoordinateSystem( CoordinateSystem* s );
+
+ /**
+ * set to show/hide the grid.
+ */
+ void setGrid( bool showgrid );
+
+ /**
+ * set to show/hide the grid.
+ */
+ void setAxes( bool showaxes );
+
+ /**
+ * set to enable/disable night-vision (visibility of hidden objects)
+ */
+ void setNightVision( bool nv );
+
+ /**
+ * Return a vector of objects that contain the given point.
+ */
+ std::vector<ObjectHolder*> whatAmIOn( const Coordinate& p, const KigWidget& w ) const;
+
+ /**
+ * Return a vector of objects that are in the given Rect.
+ */
+ std::vector<ObjectHolder*> whatIsInHere( const Rect& p, const KigWidget& );
+
+ /**
+ * Return a rect containing most of the objects, which would be a
+ * fine suggestion to map to the widget...
+ */
+ Rect suggestedRect() const;
+
+ /**
+ * Add the objects \p o to the document.
+ */
+ void addObject( ObjectHolder* oObject );
+ /**
+ * Add the objects \p os to the document.
+ */
+ void addObjects( const std::vector<ObjectHolder*>& os);
+ /**
+ * Remove the object \p o from the document.
+ */
+ void delObject( ObjectHolder* o );
+ /**
+ * Remove the objects \p os from the document.
+ */
+ void delObjects( const std::vector<ObjectHolder*>& os );
+};
+
+#endif