blob: ef4002ade98adff7bcccf72cc24f99002edd219e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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 :
|
