PageRenderTime 48ms CodeModel.GetById 16ms RepoModel.GetById 0ms app.codeStats 0ms

/XQilla-2.2.4/docs/dom3-api/classxercesc_1_1DOMUserDataHandler.html

#
HTML | 216 lines | 206 code | 9 blank | 1 comment | 0 complexity | 27aec2d2f87b69b3b2ac50f57ce05369 MD5 | raw file
Possible License(s): Apache-2.0 
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
    3. 

  3. <title>XQilla DOM3 API Documentation</title>
    4. 

  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
    5. 

  5. <link href="tabs.css" rel="stylesheet" type="text/css">
    6. 

  6. </head><body>
    7. 

  7. <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>
    8. 

  8. <!-- Generated by Doxygen 1.6.1 -->
    9. 

  9. <div class="navigation" id="top">
    10. 

  10.   <div class="tabs">
    11. 

  11.     <ul>
    12. 

  12.       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    13. 

  13.       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    14. 

  14.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    15. 

  15.       <li><a href="files.html"><span>Files</span></a></li>
    16. 

  16.       <li><a href="examples.html"><span>Examples</span></a></li>
    17. 

  17.     </ul>
    18. 

  18.   </div>
    19. 

  19.   <div class="tabs">
    20. 

  20.     <ul>
    21. 

  21.       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    22. 

  22.       <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
    23. 

  23.       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    24. 

  24.       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    25. 

  25.     </ul>
    26. 

  26.   </div>
    27. 

  27.   <div class="navpath"><a class="el" href="namespacexercesc.html">xercesc</a>::<a class="el" href="classxercesc_1_1DOMUserDataHandler.html">DOMUserDataHandler</a>
    28. 

  28.   </div>
    29. 

  29. </div>
    30. 

  30. <div class="contents">
    31. 

  31. <h1>xercesc::DOMUserDataHandler Class Reference</h1><!-- doxytag: class="xercesc::DOMUserDataHandler" -->
    32. 

  32. <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.  
    33. 

  33. <a href="#_details">More...</a></p>
    34. 

  34. 

  35. <p><code>#include &lt;<a class="el" href="DOMUserDataHandler_8hpp_source.html">DOMUserDataHandler.hpp</a>&gt;</code></p>
    36. 

  36. 

  37. <p><a href="classxercesc_1_1DOMUserDataHandler-members.html">List of all members.</a></p>
    38. 

  38. <table border="0" cellpadding="0" cellspacing="0">
    39. 

  39. <tr><td colspan="2"><h2>Public Types</h2></td></tr>
    40. 

  40. <tr><td colspan="2"><div class="groupHeader">Public Constants</div></td></tr>
    41. 

  41. <tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp029a9d96abbdf756a4ed5be1b2b6c69f"></a> </p>
    42. 

  42. <br/><br/></div></td></tr>
    43. 

  43. <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9e">DOMOperationType</a> { <br/>
    44. 

  44. &nbsp;&nbsp;<a class="el" href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9eadfea26fa9d70e0642b5831e98bd3c934">NODE_CLONED</a> =  1, 
    45. 

  45. <a class="el" href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9ead4a891edec81bedddb7f467d8a647896">NODE_IMPORTED</a> =  2, 
    46. 

  46. <a class="el" href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9ea8c5452a7aae23386814bbba70b0e5e5b">NODE_DELETED</a> =  3, 
    47. 

  47. <a class="el" href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9ea7036c145125545102ef872aa86808ed5">NODE_RENAMED</a> =  4, 
    48. 

  48. <br/>
    49. 

  49. &nbsp;&nbsp;<a class="el" href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9eaf55343c465ff0e891ab389f958d52a1e">NODE_ADOPTED</a> =  5
    50. 

  50. <br/>
    51. 

  51.  }</td></tr>
    52. 

  52. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><p>Operation Type. </p>
    53. 

  53.  <a href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9e">More...</a><br/></td></tr>
    54. 

  54. <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
    55. 

  55. <tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
    56. 

  56. <tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp22a8ec108d963f279c6a6a95aa960a57"></a> </p>
    57. 

  57. <br/><br/></div></td></tr>
    58. 

  58. <tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMUserDataHandler.html#aee363b85529d781f1c0f697350f0f97d">~DOMUserDataHandler</a> ()</td></tr>
    59. 

  59. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor.  <a href="#aee363b85529d781f1c0f697350f0f97d"></a><br/></td></tr>
    60. 

  60. <tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
    61. 

  61. <tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpe66bc56f6aa2f55926da531545b17a33"></a> </p>
    62. 

  62. <br/><br/></div></td></tr>
    63. 

  63. <tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</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>
    64. 

  64. <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="#a21ab062f7945031ec81941828e7b323b"></a><br/></td></tr>
    65. 

  65. <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
    66. 

  66. <tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
    67. 

  67. <tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp7d629e77fff660516f7d86e8f54695d0"></a> </p>
    68. 

  68. <br/><br/></div></td></tr>
    69. 

  69. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMUserDataHandler.html#aff6525ba538cf9826d8f744b4d49a021">DOMUserDataHandler</a> ()</td></tr>
    70. 

  70. </table>
    71. 

  71. <hr/><a name="_details"></a><h2>Detailed Description</h2>
    72. 

  72. <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>
    73. 

  73. <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>
    74. 

  74. <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>
    75. 

  75. <dl class="since"><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
    76. 

  76. <hr/><h2>Member Enumeration Documentation</h2>
    77. 

  77. <a class="anchor" id="a8e8bc2ef5f72e1bdae75adcc6d4ced9e"></a><!-- doxytag: member="xercesc::DOMUserDataHandler::DOMOperationType" ref="a8e8bc2ef5f72e1bdae75adcc6d4ced9e" args="" -->
    78. 

  78. <div class="memitem">
    79. 

  79. <div class="memproto">
    80. 

  80.       <table class="memname">
    81. 

  81.         <tr>
    82. 

  82.           <td class="memname">enum <a class="el" href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9e">xercesc::DOMUserDataHandler::DOMOperationType</a></td>
    83. 

  83.         </tr>
    84. 

  84.       </table>
    85. 

  85. </div>
    86. 

  86. <div class="memdoc">
    87. 

  87. 

  88. <p>Operation Type. </p>
    89. 

  89. <p><code>NODE_CLONED:</code> The node is cloned.</p>
    90. 

  90. <p><code>NODE_IMPORTED</code> The node is imported.</p>
    91. 

  91. <p><code>NODE_DELETED</code> The node is deleted.</p>
    92. 

  92. <p><code>NODE_RENAMED</code> The node is renamed.</p>
    93. 

  93. <p><code>NODE_ADOPTED</code> The node is adopted.</p>
    94. 

  94. <dl class="since"><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
    95. 

  95. <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
    96. 

  96. <tr><td valign="top"><em><a class="anchor" id="a8e8bc2ef5f72e1bdae75adcc6d4ced9eadfea26fa9d70e0642b5831e98bd3c934"></a><!-- doxytag: member="NODE_CLONED" ref="a8e8bc2ef5f72e1bdae75adcc6d4ced9eadfea26fa9d70e0642b5831e98bd3c934" args="" -->NODE_CLONED</em>&nbsp;</td><td>
    97. 

  97. </td></tr>
    98. 

  98. <tr><td valign="top"><em><a class="anchor" id="a8e8bc2ef5f72e1bdae75adcc6d4ced9ead4a891edec81bedddb7f467d8a647896"></a><!-- doxytag: member="NODE_IMPORTED" ref="a8e8bc2ef5f72e1bdae75adcc6d4ced9ead4a891edec81bedddb7f467d8a647896" args="" -->NODE_IMPORTED</em>&nbsp;</td><td>
    99. 

  99. </td></tr>
    100. 

  100. <tr><td valign="top"><em><a class="anchor" id="a8e8bc2ef5f72e1bdae75adcc6d4ced9ea8c5452a7aae23386814bbba70b0e5e5b"></a><!-- doxytag: member="NODE_DELETED" ref="a8e8bc2ef5f72e1bdae75adcc6d4ced9ea8c5452a7aae23386814bbba70b0e5e5b" args="" -->NODE_DELETED</em>&nbsp;</td><td>
    101. 

  101. </td></tr>
    102. 

  102. <tr><td valign="top"><em><a class="anchor" id="a8e8bc2ef5f72e1bdae75adcc6d4ced9ea7036c145125545102ef872aa86808ed5"></a><!-- doxytag: member="NODE_RENAMED" ref="a8e8bc2ef5f72e1bdae75adcc6d4ced9ea7036c145125545102ef872aa86808ed5" args="" -->NODE_RENAMED</em>&nbsp;</td><td>
    103. 

  103. </td></tr>
    104. 

  104. <tr><td valign="top"><em><a class="anchor" id="a8e8bc2ef5f72e1bdae75adcc6d4ced9eaf55343c465ff0e891ab389f958d52a1e"></a><!-- doxytag: member="NODE_ADOPTED" ref="a8e8bc2ef5f72e1bdae75adcc6d4ced9eaf55343c465ff0e891ab389f958d52a1e" args="" -->NODE_ADOPTED</em>&nbsp;</td><td>
    105. 

  105. </td></tr>
    106. 

  106. </table>
    107. 

  107. </dd>
    108. 

  108. </dl>
    109. 

  109. 

  110. </div>
    111. 

  111. </div>
    112. 

  112. <hr/><h2>Constructor &amp; Destructor Documentation</h2>
    113. 

  113. <a class="anchor" id="aff6525ba538cf9826d8f744b4d49a021"></a><!-- doxytag: member="xercesc::DOMUserDataHandler::DOMUserDataHandler" ref="aff6525ba538cf9826d8f744b4d49a021" args="()" -->
    114. 

  114. <div class="memitem">
    115. 

  115. <div class="memproto">
    116. 

  116.       <table class="memname">
    117. 

  117.         <tr>
    118. 

  118.           <td class="memname">xercesc::DOMUserDataHandler::DOMUserDataHandler </td>
    119. 

  119.           <td>(</td>
    120. 

  120.           <td class="paramname"></td>
    121. 

  121.           <td>&nbsp;)&nbsp;</td>
    122. 

  122.           <td><code> [inline, protected]</code></td>
    123. 

  123.         </tr>
    124. 

  124.       </table>
    125. 

  125. </div>
    126. 

  126. <div class="memdoc">
    127. 

  127. 

  128. </div>
    129. 

  129. </div>
    130. 

  130. <a class="anchor" id="aee363b85529d781f1c0f697350f0f97d"></a><!-- doxytag: member="xercesc::DOMUserDataHandler::~DOMUserDataHandler" ref="aee363b85529d781f1c0f697350f0f97d" args="()" -->
    131. 

  131. <div class="memitem">
    132. 

  132. <div class="memproto">
    133. 

  133.       <table class="memname">
    134. 

  134.         <tr>
    135. 

  135.           <td class="memname">virtual xercesc::DOMUserDataHandler::~DOMUserDataHandler </td>
    136. 

  136.           <td>(</td>
    137. 

  137.           <td class="paramname"></td>
    138. 

  138.           <td>&nbsp;)&nbsp;</td>
    139. 

  139.           <td><code> [inline, virtual]</code></td>
    140. 

  140.         </tr>
    141. 

  141.       </table>
    142. 

  142. </div>
    143. 

  143. <div class="memdoc">
    144. 

  144. 

  145. <p>Destructor. </p>
    146. 

  146. 

  147. </div>
    148. 

  148. </div>
    149. 

  149. <hr/><h2>Member Function Documentation</h2>
    150. 

  150. <a class="anchor" id="a21ab062f7945031ec81941828e7b323b"></a><!-- doxytag: member="xercesc::DOMUserDataHandler::handle" ref="a21ab062f7945031ec81941828e7b323b" args="(DOMOperationType operation, const XMLCh *const key, void *data, const DOMNode *src, DOMNode *dst)=0" -->
    151. 

  151. <div class="memitem">
    152. 

  152. <div class="memproto">
    153. 

  153.       <table class="memname">
    154. 

  154.         <tr>
    155. 

  155.           <td class="memname">virtual void xercesc::DOMUserDataHandler::handle </td>
    156. 

  156.           <td>(</td>
    157. 

  157.           <td class="paramtype"><a class="el" href="classxercesc_1_1DOMUserDataHandler.html#a8e8bc2ef5f72e1bdae75adcc6d4ced9e">DOMOperationType</a>&nbsp;</td>
    158. 

  158.           <td class="paramname"> <em>operation</em>, </td>
    159. 

  159.         </tr>
    160. 

  160.         <tr>
    161. 

  161.           <td class="paramkey"></td>
    162. 

  162.           <td></td>
    163. 

  163.           <td class="paramtype">const XMLCh *const &nbsp;</td>
    164. 

  164.           <td class="paramname"> <em>key</em>, </td>
    165. 

  165.         </tr>
    166. 

  166.         <tr>
    167. 

  167.           <td class="paramkey"></td>
    168. 

  168.           <td></td>
    169. 

  169.           <td class="paramtype">void *&nbsp;</td>
    170. 

  170.           <td class="paramname"> <em>data</em>, </td>
    171. 

  171.         </tr>
    172. 

  172.         <tr>
    173. 

  173.           <td class="paramkey"></td>
    174. 

  174.           <td></td>
    175. 

  175.           <td class="paramtype">const <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> *&nbsp;</td>
    176. 

  176.           <td class="paramname"> <em>src</em>, </td>
    177. 

  177.         </tr>
    178. 

  178.         <tr>
    179. 

  179.           <td class="paramkey"></td>
    180. 

  180.           <td></td>
    181. 

  181.           <td class="paramtype"><a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> *&nbsp;</td>
    182. 

  182.           <td class="paramname"> <em>dst</em></td><td>&nbsp;</td>
    183. 

  183.         </tr>
    184. 

  184.         <tr>
    185. 

  185.           <td></td>
    186. 

  186.           <td>)</td>
    187. 

  187.           <td></td><td></td><td><code> [pure virtual]</code></td>
    188. 

  188.         </tr>
    189. 

  189.       </table>
    190. 

  190. </div>
    191. 

  191. <div class="memdoc">
    192. 

  192. 

  193. <p>This method is called whenever the node for which this handler is registered is imported or cloned. </p>
    194. 

  194. <dl><dt><b>Parameters:</b></dt><dd>
    195. 

  195.   <table border="0" cellspacing="2" cellpadding="0">
    196. 

  196.     <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>
    197. 

  197.     <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>
    198. 

  198.     <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>
    199. 

  199.     <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>
    200. 

  200.     <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>
    201. 

  201.   </table>
    202. 

  202.   </dd>
    203. 

  203. </dl>
    204. 

  204. <dl class="since"><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
    205. 

  205. 

  206. </div>
    207. 

  207. </div>
    208. 

  208. <hr/>The documentation for this class was generated from the following file:<ul>
    209. 

  209. <li><a class="el" href="DOMUserDataHandler_8hpp_source.html">DOMUserDataHandler.hpp</a></li>
    210. 

  210. </ul>
    211. 

  211. </div>
    212. 

  212. <hr size="1"/><address style="text-align: right;"><small>Generated on Mon Mar 1 21:16:36 2010 for XQilla DOM Level 3 API by&nbsp;
    213. 

  213. <a href="http://www.doxygen.org/index.html">
    214. 

  214. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
    215. 

  215. </body>
    216. 

  216. </html>
    217. 

  217.