240 lines
13 KiB
HTML
240 lines
13 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>XQilla DOM3 API Documentation</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&type=2" border="0" alt="SourceForge.net Logo" /></a>
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li><a href="examples.html"><span>Examples</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespacexercesc.html">xercesc</a></li><li class="navelem"><a class="el" href="classxercesc_1_1DOMUserDataHandler.html">DOMUserDataHandler</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="classxercesc_1_1DOMUserDataHandler-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">xercesc::DOMUserDataHandler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>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="classxercesc_1_1DOMUserDataHandler.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="DOMUserDataHandler_8hpp_source.html">DOMUserDataHandler.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Public Constants</div></td></tr>
|
|
<tr class="memitem:a8e8bc2ef5f72e1bdae75adcc6d4ced9e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9e">DOMOperationType</a> { <br/>
|
|
  <a class="el" href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9eadfea26fa9d70e0642b5831e98bd3c934">NODE_CLONED</a> = 1,
|
|
<a class="el" href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9ead4a891edec81bedddb7f467d8a647896">NODE_IMPORTED</a> = 2,
|
|
<a class="el" href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9ea8c5452a7aae23386814bbba70b0e5e5b">NODE_DELETED</a> = 3,
|
|
<a class="el" href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9ea7036c145125545102ef872aa86808ed5">NODE_RENAMED</a> = 4,
|
|
<br/>
|
|
  <a class="el" href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9eaf55343c465ff0e891ab389f958d52a1e">NODE_ADOPTED</a> = 5
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:a8e8bc2ef5f72e1bdae75adcc6d4ced9e"><td class="mdescLeft"> </td><td class="mdescRight">Operation Type. <a href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9e">More...</a><br/></td></tr>
|
|
<tr class="separator:a8e8bc2ef5f72e1bdae75adcc6d4ced9e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
|
|
<tr class="memitem:aee363b85529d781f1c0f697350f0f97d"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMUserDataHandler.html#aee363b85529d781f1c0f697350f0f97d">~DOMUserDataHandler</a> ()</td></tr>
|
|
<tr class="memdesc:aee363b85529d781f1c0f697350f0f97d"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aee363b85529d781f1c0f697350f0f97d">More...</a><br/></td></tr>
|
|
<tr class="separator:aee363b85529d781f1c0f697350f0f97d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
|
|
<tr class="memitem:a21ab062f7945031ec81941828e7b323b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMUserDataHandler.html#a21ab062f7945031ec81941828e7b323b">handle</a> (<a class="el" href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9e">DOMOperationType</a> operation, const XMLCh *const key, void *data, const <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> *src, <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> *dst)=0</td></tr>
|
|
<tr class="memdesc:a21ab062f7945031ec81941828e7b323b"><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="#a21ab062f7945031ec81941828e7b323b">More...</a><br/></td></tr>
|
|
<tr class="separator:a21ab062f7945031ec81941828e7b323b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
|
|
<tr class="memitem:aff6525ba538cf9826d8f744b4d49a021"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMUserDataHandler.html#aff6525ba538cf9826d8f744b4d49a021">DOMUserDataHandler</a> ()</td></tr>
|
|
<tr class="separator:aff6525ba538cf9826d8f744b4d49a021"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>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>
|
|
<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>
|
|
<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>. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
|
|
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
|
|
<a class="anchor" id="a8e8bc2ef5f72e1bdae75adcc6d4ced9e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9e">xercesc::DOMUserDataHandler::DOMOperationType</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Operation Type. </p>
|
|
<p><code>NODE_CLONED:</code> The node is cloned.</p>
|
|
<p><code>NODE_IMPORTED</code> The node is imported.</p>
|
|
<p><code>NODE_DELETED</code> The node is deleted.</p>
|
|
<p><code>NODE_RENAMED</code> The node is renamed.</p>
|
|
<p><code>NODE_ADOPTED</code> The node is adopted.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a8e8bc2ef5f72e1bdae75adcc6d4ced9eadfea26fa9d70e0642b5831e98bd3c934"></a>NODE_CLONED</em> </td><td class="fielddoc">
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="a8e8bc2ef5f72e1bdae75adcc6d4ced9ead4a891edec81bedddb7f467d8a647896"></a>NODE_IMPORTED</em> </td><td class="fielddoc">
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="a8e8bc2ef5f72e1bdae75adcc6d4ced9ea8c5452a7aae23386814bbba70b0e5e5b"></a>NODE_DELETED</em> </td><td class="fielddoc">
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="a8e8bc2ef5f72e1bdae75adcc6d4ced9ea7036c145125545102ef872aa86808ed5"></a>NODE_RENAMED</em> </td><td class="fielddoc">
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="a8e8bc2ef5f72e1bdae75adcc6d4ced9eaf55343c465ff0e891ab389f958d52a1e"></a>NODE_ADOPTED</em> </td><td class="fielddoc">
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="aff6525ba538cf9826d8f744b4d49a021"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">xercesc::DOMUserDataHandler::DOMUserDataHandler </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aee363b85529d781f1c0f697350f0f97d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual xercesc::DOMUserDataHandler::~DOMUserDataHandler </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a21ab062f7945031ec81941828e7b323b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void xercesc::DOMUserDataHandler::handle </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9e">DOMOperationType</a> </td>
|
|
<td class="paramname"><em>operation</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const XMLCh *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="classxercesc_1_1DOMNode.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="classxercesc_1_1DOMNode.html">DOMNode</a> * </td>
|
|
<td class="paramname"><em>dst</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </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 class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">operation</td><td>Specifies the type of operation that is being performed on the node. </td></tr>
|
|
<tr><td class="paramname">key</td><td>Specifies the key for which this handler is being called. </td></tr>
|
|
<tr><td class="paramname">data</td><td>Specifies the data for which this handler is being called. </td></tr>
|
|
<tr><td class="paramname">src</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 class="paramname">dst</td><td>Specifies the node newly created if any, or <code>null</code>.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<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></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|