convert NR to Geom

[inkscape.git] / src / xml / subtree.h

diff --git a/src/xml/subtree.h b/src/xml/subtree.h
index 73a6485d1eb641f20de7707bb558e31ed4119e8b..07996e6a68b5c1a246b6c2c78fb947ccfdb13d0e 100644 (file)
--- a/src/xml/subtree.h
+++ b/src/xml/subtree.h
@@ -1,7 +1,7 @@
-/*
- * XML::Subtree - proxy for an XML subtree
- *
- * Copyright 2005 MenTaLguY <mental@rydia.net>
+/** @file
+ * @brief Object representing a subtree of the XML document
+ */
+/* Copyright 2005 MenTaLguY <mental@rydia.net>
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -15,45 +15,49 @@
 #ifndef SEEN_INKSCAPE_XML_SUBTREE_H
 #define SEEN_INKSCAPE_XML_SUBTREE_H
 
-#include "xml/node-observer.h"
+#include "gc-managed.h"
+#include "xml/xml-forward.h"
 #include "xml/composite-node-observer.h"
 
 namespace Inkscape {
 namespace XML {
 
-class Node;
-
-class Subtree : public Inkscape::GC::Anchored,
-                public Inkscape::GC::Managed<>,
-                private NodeObserver
-{
+/**
+ * @brief Represents a node and all its descendants
+ *
+ * This is a convenience object for node operations that affect all of the node's descendants.
+ * Currently the only such operations are adding and removing subtree observers
+ * and synthesizing events for the entire subtree.
+ */
+class Subtree : public GC::Managed<GC::SCANNED, GC::MANUAL> {
 public:
     Subtree(Node &root);
     ~Subtree();
 
-    void finish();
-
+    /**
+     * @brief Synthesize events for the entire subtree
+     *
+     * This method notifies the specified observer of node changes equivalent to creating
+     * this subtree from scratch. The notifications recurse into the tree depth-first.
+     * Currently this is the only method that provides extra functionality compared to
+     * the public methods of Node.
+     */
     void synthesizeEvents(NodeObserver &observer);
+    /**
+     * @brief Add an observer watching for subtree changes
+     *
+     * Equivalent to Node::addSubtreeObserver().
+     */
     void addObserver(NodeObserver &observer);
+    /**
+     * @brief Add an observer watching for subtree changes
+     *
+     * Equivalent to Node::removeSubtreeObserver().
+     */
     void removeObserver(NodeObserver &observer);
 
 private:
-    void notifyChildAdded(Node &node, Node &child, Node *prev);
-
-    void notifyChildRemoved(Node &node, Node &child, Node *prev);
-
-    void notifyChildOrderChanged(Node &node, Node &child,
-                                 Node *old_prev, Node *new_prev);
-
-    void notifyContentChanged(Node &node,
-                              Util::ptr_shared<char> old_content,
-                              Util::ptr_shared<char> new_content);
-
-    void notifyAttributeChanged(Node &node, GQuark name,
-                                Util::ptr_shared<char> old_value,
-                                Util::ptr_shared<char> new_value);
-
-    Node *_root;
+    Node &_root;
     CompositeNodeObserver _observers;
 };