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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Xerces-C++: DOMUserDataHandler Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>DOMUserDataHandler Class Reference</h1><!-- doxytag: class="DOMUserDataHandler" -->When associating an object to a key on a node using <code>setUserData</code> the application can provide a handler that gets called when the node the object is associated to is being cloned or imported.
<a href="#_details">More...</a>
<p>
<p>
<a href="classDOMUserDataHandler-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Public Constants</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMUserDataHandler.html#3fc45270dfc120a0d28090570e543869">DOMOperationType</a> { <br>
<a class="el" href="classDOMUserDataHandler.html#3fc45270dfc120a0d28090570e543869e4124a76c0b45067ad33d94d51f57c8b">NODE_CLONED</a> = 1,
<a class="el" href="classDOMUserDataHandler.html#3fc45270dfc120a0d28090570e543869dfded424f2d618b5903306add9283629">NODE_IMPORTED</a> = 2,
<a class="el" href="classDOMUserDataHandler.html#3fc45270dfc120a0d28090570e543869e65fa5913524dc1ad8383f3707376571">NODE_DELETED</a> = 3,
<a class="el" href="classDOMUserDataHandler.html#3fc45270dfc120a0d28090570e543869bc9e1802f11627cec5e4304aeef57090">NODE_RENAMED</a> = 4,
<br>
<a class="el" href="classDOMUserDataHandler.html#3fc45270dfc120a0d28090570e5438699d7fbd01f0a955bca4b39f6d8a765316">NODE_ADOPTED</a> = 5
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Operation Type. <a href="classDOMUserDataHandler.html#3fc45270dfc120a0d28090570e543869">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMUserDataHandler.html#c56b9c2d438394b714f9c6bf2ee2c4f4">~DOMUserDataHandler</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#c56b9c2d438394b714f9c6bf2ee2c4f4"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMUserDataHandler.html#db241add04a9e9af108549ab61d121f9">handle</a> (<a class="el" href="classDOMUserDataHandler.html#3fc45270dfc120a0d28090570e543869">DOMOperationType</a> operation, const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> *const key, void *data, const <a class="el" href="classDOMNode.html">DOMNode</a> *src, <a class="el" href="classDOMNode.html">DOMNode</a> *dst)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method is called whenever the node for which this handler is registered is imported or cloned. <a href="#db241add04a9e9af108549ab61d121f9"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMUserDataHandler.html#49d70baa6c54e9054421a19e93081118">DOMUserDataHandler</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
When associating an object to a key on a node using <code>setUserData</code> the application can provide a handler that gets called when the node the object is associated to is being cloned or imported.
<p>
This can be used by the application to implement various behaviors regarding the data it associates to the DOM nodes. This interface defines that handler.<p>
See also the <a href="http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407">Document Object Model (DOM) Level 3 Core Specification</a>. <dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="3fc45270dfc120a0d28090570e543869"></a><!-- doxytag: member="DOMUserDataHandler::DOMOperationType" ref="3fc45270dfc120a0d28090570e543869" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classDOMUserDataHandler.html#3fc45270dfc120a0d28090570e543869">DOMUserDataHandler::DOMOperationType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Operation Type.
<p>
<code>NODE_CLONED:</code> The node is cloned.<p>
<code>NODE_IMPORTED</code> The node is imported.<p>
<code>NODE_DELETED</code> The node is deleted.<p>
<code>NODE_RENAMED</code> The node is renamed.<p>
<code>NODE_ADOPTED</code> The node is adopted.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="3fc45270dfc120a0d28090570e543869e4124a76c0b45067ad33d94d51f57c8b"></a><!-- doxytag: member="NODE_CLONED" ref="3fc45270dfc120a0d28090570e543869e4124a76c0b45067ad33d94d51f57c8b" args="" -->NODE_CLONED</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="3fc45270dfc120a0d28090570e543869dfded424f2d618b5903306add9283629"></a><!-- doxytag: member="NODE_IMPORTED" ref="3fc45270dfc120a0d28090570e543869dfded424f2d618b5903306add9283629" args="" -->NODE_IMPORTED</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="3fc45270dfc120a0d28090570e543869e65fa5913524dc1ad8383f3707376571"></a><!-- doxytag: member="NODE_DELETED" ref="3fc45270dfc120a0d28090570e543869e65fa5913524dc1ad8383f3707376571" args="" -->NODE_DELETED</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="3fc45270dfc120a0d28090570e543869bc9e1802f11627cec5e4304aeef57090"></a><!-- doxytag: member="NODE_RENAMED" ref="3fc45270dfc120a0d28090570e543869bc9e1802f11627cec5e4304aeef57090" args="" -->NODE_RENAMED</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="3fc45270dfc120a0d28090570e5438699d7fbd01f0a955bca4b39f6d8a765316"></a><!-- doxytag: member="NODE_ADOPTED" ref="3fc45270dfc120a0d28090570e5438699d7fbd01f0a955bca4b39f6d8a765316" args="" -->NODE_ADOPTED</em> </td><td>
</td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="49d70baa6c54e9054421a19e93081118"></a><!-- doxytag: member="DOMUserDataHandler::DOMUserDataHandler" ref="49d70baa6c54e9054421a19e93081118" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DOMUserDataHandler::DOMUserDataHandler </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="c56b9c2d438394b714f9c6bf2ee2c4f4"></a><!-- doxytag: member="DOMUserDataHandler::~DOMUserDataHandler" ref="c56b9c2d438394b714f9c6bf2ee2c4f4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual DOMUserDataHandler::~DOMUserDataHandler </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="db241add04a9e9af108549ab61d121f9"></a><!-- doxytag: member="DOMUserDataHandler::handle" ref="db241add04a9e9af108549ab61d121f9" args="(DOMOperationType operation, const XMLCh *const key, void *data, const DOMNode *src, DOMNode *dst)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void DOMUserDataHandler::handle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDOMUserDataHandler.html#3fc45270dfc120a0d28090570e543869">DOMOperationType</a> </td>
<td class="paramname"> <em>operation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#fae8f92d83170d97f757f704eca7f52a">XMLCh</a> *const </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classDOMNode.html">DOMNode</a> * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDOMNode.html">DOMNode</a> * </td>
<td class="paramname"> <em>dst</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method is called whenever the node for which this handler is registered is imported or cloned.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>operation</em> </td><td>Specifies the type of operation that is being performed on the node. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Specifies the key for which this handler is being called. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Specifies the data for which this handler is being called. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>Specifies the node being cloned, adopted, imported, or renamed. This is <code>null</code> when the node is being deleted. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dst</em> </td><td>Specifies the node newly created if any, or <code>null</code>.</td></tr>
</table>
</dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DOMUserDataHandler_8hpp-source.html">DOMUserDataHandler.hpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Apr 21 17:55:50 2010 for Xerces-C++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
|
