summaryrefslogtreecommitdiffstats
path: root/src/xml/subtree.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 16:29:01 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 16:29:01 +0000
commit35a96bde514a8897f6f0fcc41c5833bf63df2e2a (patch)
tree657d15a03cc46bd099fc2c6546a7a4ad43815d9f /src/xml/subtree.h
parentInitial commit. (diff)
downloadinkscape-35a96bde514a8897f6f0fcc41c5833bf63df2e2a.tar.xz
inkscape-35a96bde514a8897f6f0fcc41c5833bf63df2e2a.zip
Adding upstream version 1.0.2.upstream/1.0.2upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/xml/subtree.h')
-rw-r--r--src/xml/subtree.h74
1 files changed, 74 insertions, 0 deletions
diff --git a/src/xml/subtree.h b/src/xml/subtree.h
new file mode 100644
index 0000000..ef4002a
--- /dev/null
+++ b/src/xml/subtree.h
@@ -0,0 +1,74 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/** @file
+ * @brief Object representing a subtree of the XML document
+ *//*
+ * Authors: see git history
+ *
+ * Copyright (C) 2015 Authors
+ * Copyright 2005 MenTaLguY <mental@rydia.net>
+ *
+ * Released under GNU GPL v2+, read the file 'COPYING' for more information.
+ */
+
+#ifndef SEEN_INKSCAPE_XML_SUBTREE_H
+#define SEEN_INKSCAPE_XML_SUBTREE_H
+
+#include "inkgc/gc-managed.h"
+#include "xml/composite-node-observer.h"
+
+namespace Inkscape {
+namespace XML {
+
+/**
+ * @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();
+
+ /**
+ * @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:
+ Node &_root;
+ CompositeNodeObserver _observers;
+};
+
+}
+}
+
+#endif
+/*
+ Local Variables:
+ mode:c++
+ c-file-style:"stroustrup"
+ c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
+ indent-tabs-mode:nil
+ fill-column:99
+ End:
+*/
+// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :