mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
XQuilla/docs/dom3-api/classxercesc_1_1DOMUserDataHandler.html
King_DuckZ 4bc0157dcd v2.2.0
2020-02-17 22:17:06 +01:00

218 lines
13 KiB
HTML
Raw Blame History

<!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&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.5.5 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespacexercesc.html">xercesc</a>::<a class="el" href="classxercesc_1_1DOMUserDataHandler.html">DOMUserDataHandler</a>
</div>
</div>
<div class="contents">
<h1>xercesc::DOMUserDataHandler Class Reference</h1><!-- doxytag: class="xercesc::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>
<code>#include &lt;<a class="el" href="DOMUserDataHandler_8hpp-source.html">DOMUserDataHandler.hpp</a>&gt;</code>
<p>
<p>
<a href="classxercesc_1_1DOMUserDataHandler-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 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMUserDataHandler.html#8e8bc2ef5f72e1bdae75adcc6d4ced9e">DOMOperationType</a> { <br>
&nbsp;&nbsp;<a class="el" href="classxercesc_1_1DOMUserDataHandler.html#8e8bc2ef5f72e1bdae75adcc6d4ced9edfea26fa9d70e0642b5831e98bd3c934">NODE_CLONED</a> = 1,
<a class="el" href="classxercesc_1_1DOMUserDataHandler.html#8e8bc2ef5f72e1bdae75adcc6d4ced9ed4a891edec81bedddb7f467d8a647896">NODE_IMPORTED</a> = 2,
<a class="el" href="classxercesc_1_1DOMUserDataHandler.html#8e8bc2ef5f72e1bdae75adcc6d4ced9e8c5452a7aae23386814bbba70b0e5e5b">NODE_DELETED</a> = 3,
<a class="el" href="classxercesc_1_1DOMUserDataHandler.html#8e8bc2ef5f72e1bdae75adcc6d4ced9e7036c145125545102ef872aa86808ed5">NODE_RENAMED</a> = 4,
<br>
&nbsp;&nbsp;<a class="el" href="classxercesc_1_1DOMUserDataHandler.html#8e8bc2ef5f72e1bdae75adcc6d4ced9ef55343c465ff0e891ab389f958d52a1e">NODE_ADOPTED</a> = 5
<br>
}</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Operation Type. <a href="classxercesc_1_1DOMUserDataHandler.html#8e8bc2ef5f72e1bdae75adcc6d4ced9e">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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMUserDataHandler.html#ee363b85529d781f1c0f697350f0f97d">~DOMUserDataHandler</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#ee363b85529d781f1c0f697350f0f97d"></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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMUserDataHandler.html#21ab062f7945031ec81941828e7b323b">handle</a> (<a class="el" href="classxercesc_1_1DOMUserDataHandler.html#8e8bc2ef5f72e1bdae75adcc6d4ced9e">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><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method is called whenever the node for which this handler is registered is imported or cloned. <a href="#21ab062f7945031ec81941828e7b323b"></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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMUserDataHandler.html#ff6525ba538cf9826d8f744b4d49a021">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="8e8bc2ef5f72e1bdae75adcc6d4ced9e"></a><!-- doxytag: member="xercesc::DOMUserDataHandler::DOMOperationType" ref="8e8bc2ef5f72e1bdae75adcc6d4ced9e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classxercesc_1_1DOMUserDataHandler.html#8e8bc2ef5f72e1bdae75adcc6d4ced9e">xercesc::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="8e8bc2ef5f72e1bdae75adcc6d4ced9edfea26fa9d70e0642b5831e98bd3c934"></a><!-- doxytag: member="NODE_CLONED" ref="8e8bc2ef5f72e1bdae75adcc6d4ced9edfea26fa9d70e0642b5831e98bd3c934" args="" -->NODE_CLONED</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="8e8bc2ef5f72e1bdae75adcc6d4ced9ed4a891edec81bedddb7f467d8a647896"></a><!-- doxytag: member="NODE_IMPORTED" ref="8e8bc2ef5f72e1bdae75adcc6d4ced9ed4a891edec81bedddb7f467d8a647896" args="" -->NODE_IMPORTED</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="8e8bc2ef5f72e1bdae75adcc6d4ced9e8c5452a7aae23386814bbba70b0e5e5b"></a><!-- doxytag: member="NODE_DELETED" ref="8e8bc2ef5f72e1bdae75adcc6d4ced9e8c5452a7aae23386814bbba70b0e5e5b" args="" -->NODE_DELETED</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="8e8bc2ef5f72e1bdae75adcc6d4ced9e7036c145125545102ef872aa86808ed5"></a><!-- doxytag: member="NODE_RENAMED" ref="8e8bc2ef5f72e1bdae75adcc6d4ced9e7036c145125545102ef872aa86808ed5" args="" -->NODE_RENAMED</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="8e8bc2ef5f72e1bdae75adcc6d4ced9ef55343c465ff0e891ab389f958d52a1e"></a><!-- doxytag: member="NODE_ADOPTED" ref="8e8bc2ef5f72e1bdae75adcc6d4ced9ef55343c465ff0e891ab389f958d52a1e" args="" -->NODE_ADOPTED</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="ff6525ba538cf9826d8f744b4d49a021"></a><!-- doxytag: member="xercesc::DOMUserDataHandler::DOMUserDataHandler" ref="ff6525ba538cf9826d8f744b4d49a021" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::DOMUserDataHandler::DOMUserDataHandler </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="ee363b85529d781f1c0f697350f0f97d"></a><!-- doxytag: member="xercesc::DOMUserDataHandler::~DOMUserDataHandler" ref="ee363b85529d781f1c0f697350f0f97d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual xercesc::DOMUserDataHandler::~DOMUserDataHandler </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, 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="21ab062f7945031ec81941828e7b323b"></a><!-- doxytag: member="xercesc::DOMUserDataHandler::handle" ref="21ab062f7945031ec81941828e7b323b" 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 xercesc::DOMUserDataHandler::handle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classxercesc_1_1DOMUserDataHandler.html#8e8bc2ef5f72e1bdae75adcc6d4ced9e">DOMOperationType</a>&nbsp;</td>
<td class="paramname"> <em>operation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</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> *&nbsp;</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> *&nbsp;</td>
<td class="paramname"> <em>dst</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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 Mon Jan 5 19:54:58 2009 for XQilla DOM Level 3 API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink