mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
XQuilla/docs/dom3-api/classxercesc_1_1DOMWriter.html
King_DuckZ c04629cb7b v2.1.2
2020-02-17 22:14:54 +01:00

622 lines
34 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.1 -->
<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 id="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&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="nav">
<a class="el" href="namespacexercesc.html">xercesc</a>::<a class="el" href="classxercesc_1_1DOMWriter.html">DOMWriter</a></div>
<h1>xercesc::DOMWriter Class Reference</h1><!-- doxytag: class="xercesc::DOMWriter" --><code>#include &lt;<a class="el" href="DOMWriter_8hpp-source.html">DOMWriter.hpp</a>&gt;</code>
<p>
<a href="classxercesc_1_1DOMWriter-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 Member Functions</h2></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 bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMWriter.html#210ea59f51169be505165677139b8a96">canSetFeature</a> (const XMLCh *const featName, bool state) const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Query whether setting a feature to a specific value is supported. <a href="#210ea59f51169be505165677139b8a96"></a><br></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_1DOMWriter.html#bea5370f984ee1a22cd420e7d1e1b67c">setFeature</a> (const XMLCh *const featName, bool state)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the state of a feature. <a href="#bea5370f984ee1a22cd420e7d1e1b67c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMWriter.html#dec8f5a11c793ec3a6a96ee80be132a2">getFeature</a> (const XMLCh *const featName) const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Look up the value of a feature. <a href="#dec8f5a11c793ec3a6a96ee80be132a2"></a><br></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_1DOMWriter.html#9826abdbb33f85f59e7bba0777bb781c">setEncoding</a> (const XMLCh *const encoding)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The character encoding in which the output will be written. <a href="#9826abdbb33f85f59e7bba0777bb781c"></a><br></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_1DOMWriter.html#0522dcac9fee7fbb8b3330456069cf0c">setNewLine</a> (const XMLCh *const newLine)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The end-of-line sequence of characters to be used in the XML being written out. <a href="#0522dcac9fee7fbb8b3330456069cf0c"></a><br></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_1DOMWriter.html#4425eaac49c557c7d2ac75b092602bc7">setErrorHandler</a> (<a class="el" href="classxercesc_1_1DOMErrorHandler.html">DOMErrorHandler</a> *errorHandler)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The error handler that will receive error notifications during serialization. <a href="#4425eaac49c557c7d2ac75b092602bc7"></a><br></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_1DOMWriter.html#ba1e3c9a7be87cd5d816d9d8e9e3f7ad">setFilter</a> (<a class="el" href="classxercesc_1_1DOMWriterFilter.html">DOMWriterFilter</a> *filter)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">When the application provides a filter, the serializer will call out to the filter before serializing each Node. <a href="#ba1e3c9a7be87cd5d816d9d8e9e3f7ad"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMWriter.html#32dbf642d60001b0a17c537c23dcf8d8">getEncoding</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the character encoding in which the output will be written. <a href="#32dbf642d60001b0a17c537c23dcf8d8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMWriter.html#f41aed928b8c023f148d8175faa10e19">getNewLine</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the end-of-line sequence of characters to be used in the XML being written out. <a href="#f41aed928b8c023f148d8175faa10e19"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMErrorHandler.html">DOMErrorHandler</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMWriter.html#0c7a1d64d226063fbd290088869434d3">getErrorHandler</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the error handler that will receive error notifications during serialization. <a href="#0c7a1d64d226063fbd290088869434d3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMWriterFilter.html">DOMWriterFilter</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMWriter.html#8900ee97b5419fa34f4df616181b42a2">getFilter</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the WriterFilter used. <a href="#8900ee97b5419fa34f4df616181b42a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMWriter.html#715500b3f075de6fa53a5bb7e7c3bfcf">writeNode</a> (XMLFormatTarget *const destination, const <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> &amp;nodeToWrite)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write out the specified node as described above in the description of <code><a class="el" href="classxercesc_1_1DOMWriter.html">DOMWriter</a></code>. <a href="#715500b3f075de6fa53a5bb7e7c3bfcf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMWriter.html#1ed776eee2becf0052981ff5968d1349">writeToString</a> (const <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> &amp;nodeToWrite)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Serialize the specified node as described above in the description of <code><a class="el" href="classxercesc_1_1DOMWriter.html">DOMWriter</a></code>. <a href="#1ed776eee2becf0052981ff5968d1349"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Non-standard Extension</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_1DOMWriter.html#641ef60cbd02a6182176343b457ddfc7">release</a> ()=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called to indicate that this Writer is no longer in use and that the implementation may relinquish any resources associated with it. <a href="#641ef60cbd02a6182176343b457ddfc7"></a><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="618b7f97fdfe565eb947b5cf6a330ddb"></a><!-- doxytag: member="xercesc::DOMWriter::DOMWriter" ref="618b7f97fdfe565eb947b5cf6a330ddb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::DOMWriter::DOMWriter </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="cf268aca1311ee78dffbd1439f04a6a7"></a><!-- doxytag: member="xercesc::DOMWriter::~DOMWriter" ref="cf268aca1311ee78dffbd1439f04a6a7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual xercesc::DOMWriter::~DOMWriter </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>
<a class="anchor" name="618b7f97fdfe565eb947b5cf6a330ddb"></a><!-- doxytag: member="xercesc::DOMWriter::DOMWriter" ref="618b7f97fdfe565eb947b5cf6a330ddb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::DOMWriter::DOMWriter </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="cf268aca1311ee78dffbd1439f04a6a7"></a><!-- doxytag: member="xercesc::DOMWriter::~DOMWriter" ref="cf268aca1311ee78dffbd1439f04a6a7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual xercesc::DOMWriter::~DOMWriter </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="210ea59f51169be505165677139b8a96"></a><!-- doxytag: member="xercesc::DOMWriter::canSetFeature" ref="210ea59f51169be505165677139b8a96" args="(const XMLCh *const featName, bool state) const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool xercesc::DOMWriter::canSetFeature </td>
<td>(</td>
<td class="paramtype">const XMLCh *const&nbsp;</td>
<td class="paramname"> <em>featName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>state</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query whether setting a feature to a specific value is supported.
<p>
<br>
The feature name has the same form as a DOM hasFeature string.<p>
<b>"Experimental - subject to change"</b><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>featName</em>&nbsp;</td><td>The feature name, which is a DOM has-feature style string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>state</em>&nbsp;</td><td>The requested state of the feature (<code>true</code> or <code>false</code>). </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if the feature could be successfully set to the specified value, or <code>false</code> if the feature is not recognized or the requested value is not supported. The value of the feature itself is not changed. </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div><p>
<a class="anchor" name="bea5370f984ee1a22cd420e7d1e1b67c"></a><!-- doxytag: member="xercesc::DOMWriter::setFeature" ref="bea5370f984ee1a22cd420e7d1e1b67c" args="(const XMLCh *const featName, bool state)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xercesc::DOMWriter::setFeature </td>
<td>(</td>
<td class="paramtype">const XMLCh *const&nbsp;</td>
<td class="paramname"> <em>featName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>state</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>
Set the state of a feature.
<p>
<br>
The feature name has the same form as a DOM hasFeature string. <br>
It is possible for a <code><a class="el" href="classxercesc_1_1DOMWriter.html">DOMWriter</a></code> to recognize a feature name but to be unable to set its value.<p>
<b>"Experimental - subject to change"</b><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>featName</em>&nbsp;</td><td>The feature name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>state</em>&nbsp;</td><td>The requested state of the feature (<code>true</code> or <code>false</code>). </td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classxercesc_1_1DOMException.html">DOMException</a></em>&nbsp;</td><td>Raise a NOT_SUPPORTED_ERR exception when the <code><a class="el" href="classxercesc_1_1DOMWriter.html">DOMWriter</a></code> recognizes the feature name but cannot set the requested value. <br>
Raise a NOT_FOUND_ERR When the <code><a class="el" href="classxercesc_1_1DOMWriter.html">DOMWriter</a></code> does not recognize the feature name. </td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMWriter.html#dec8f5a11c793ec3a6a96ee80be132a2">getFeature</a> </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div><p>
<a class="anchor" name="dec8f5a11c793ec3a6a96ee80be132a2"></a><!-- doxytag: member="xercesc::DOMWriter::getFeature" ref="dec8f5a11c793ec3a6a96ee80be132a2" args="(const XMLCh *const featName) const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool xercesc::DOMWriter::getFeature </td>
<td>(</td>
<td class="paramtype">const XMLCh *const&nbsp;</td>
<td class="paramname"> <em>featName</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Look up the value of a feature.
<p>
<br>
The feature name has the same form as a DOM hasFeature string <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>featName</em>&nbsp;</td><td>The feature name, which is a string with DOM has-feature syntax. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The current state of the feature (<code>true</code> or <code>false</code>). </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classxercesc_1_1DOMException.html">DOMException</a></em>&nbsp;</td><td>Raise a NOT_FOUND_ERR When the <code><a class="el" href="classxercesc_1_1DOMWriter.html">DOMWriter</a></code> does not recognize the feature name.</td></tr>
</table>
</dl>
<p>
<b>"Experimental - subject to change"</b><p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMWriter.html#bea5370f984ee1a22cd420e7d1e1b67c">setFeature</a> </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div><p>
<a class="anchor" name="9826abdbb33f85f59e7bba0777bb781c"></a><!-- doxytag: member="xercesc::DOMWriter::setEncoding" ref="9826abdbb33f85f59e7bba0777bb781c" args="(const XMLCh *const encoding)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xercesc::DOMWriter::setEncoding </td>
<td>(</td>
<td class="paramtype">const XMLCh *const&nbsp;</td>
<td class="paramname"> <em>encoding</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The character encoding in which the output will be written.
<p>
<br>
The encoding to use when writing is determined as follows: If the encoding attribute has been set, that value will be used.If the encoding attribute is <code>null</code> or empty, but the item to be written includes an encoding declaration, that value will be used.If neither of the above provides an encoding name, a default encoding of "UTF-8" will be used. <br>
The default value is <code>null</code>.<p>
<b>"Experimental - subject to change"</b><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>encoding</em>&nbsp;</td><td>The character encoding in which the output will be written. </td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMWriter.html#32dbf642d60001b0a17c537c23dcf8d8">getEncoding</a> </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div><p>
<a class="anchor" name="0522dcac9fee7fbb8b3330456069cf0c"></a><!-- doxytag: member="xercesc::DOMWriter::setNewLine" ref="0522dcac9fee7fbb8b3330456069cf0c" args="(const XMLCh *const newLine)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xercesc::DOMWriter::setNewLine </td>
<td>(</td>
<td class="paramtype">const XMLCh *const&nbsp;</td>
<td class="paramname"> <em>newLine</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The end-of-line sequence of characters to be used in the XML being written out.
<p>
The only permitted values are these: <dl>
<dt><code>null</code> </dt>
<dd>Use a default end-of-line sequence. DOM implementations should choose the default to match the usual convention for text files in the environment being used. Implementations must choose a default sequence that matches one of those allowed by 2.11 "End-of-Line Handling". </dd>
<dt>CR </dt>
<dd>The carriage-return character (xD). </dd>
<dt>CR-LF </dt>
<dd>The carriage-return and line-feed characters (xD xA). </dd>
<dt>LF </dt>
<dd>The line-feed character (xA). </dd>
</dl>
<br>
The default value for this attribute is <code>null</code>.<p>
<b>"Experimental - subject to change"</b><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>newLine</em>&nbsp;</td><td>The end-of-line sequence of characters to be used. </td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMWriter.html#f41aed928b8c023f148d8175faa10e19">getNewLine</a> </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div><p>
<a class="anchor" name="4425eaac49c557c7d2ac75b092602bc7"></a><!-- doxytag: member="xercesc::DOMWriter::setErrorHandler" ref="4425eaac49c557c7d2ac75b092602bc7" args="(DOMErrorHandler *errorHandler)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xercesc::DOMWriter::setErrorHandler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classxercesc_1_1DOMErrorHandler.html">DOMErrorHandler</a> *&nbsp;</td>
<td class="paramname"> <em>errorHandler</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The error handler that will receive error notifications during serialization.
<p>
The node where the error occured is passed to this error handler, any modification to nodes from within an error callback should be avoided since this will result in undefined, implementation dependent behavior.<p>
<b>"Experimental - subject to change"</b><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>errorHandler</em>&nbsp;</td><td>The error handler to be used. </td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMWriter.html#0c7a1d64d226063fbd290088869434d3">getErrorHandler</a> </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div><p>
<a class="anchor" name="ba1e3c9a7be87cd5d816d9d8e9e3f7ad"></a><!-- doxytag: member="xercesc::DOMWriter::setFilter" ref="ba1e3c9a7be87cd5d816d9d8e9e3f7ad" args="(DOMWriterFilter *filter)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xercesc::DOMWriter::setFilter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classxercesc_1_1DOMWriterFilter.html">DOMWriterFilter</a> *&nbsp;</td>
<td class="paramname"> <em>filter</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
When the application provides a filter, the serializer will call out to the filter before serializing each Node.
<p>
Attribute nodes are never passed to the filter. The filter implementation can choose to remove the node from the stream or to terminate the serialization early.<p>
<b>"Experimental - subject to change"</b><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>filter</em>&nbsp;</td><td>The writer filter to be used. </td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMWriter.html#8900ee97b5419fa34f4df616181b42a2">getFilter</a> </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div><p>
<a class="anchor" name="32dbf642d60001b0a17c537c23dcf8d8"></a><!-- doxytag: member="xercesc::DOMWriter::getEncoding" ref="32dbf642d60001b0a17c537c23dcf8d8" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const XMLCh* xercesc::DOMWriter::getEncoding </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the character encoding in which the output will be written.
<p>
<b>"Experimental - subject to change"</b><p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The character encoding used. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMWriter.html#9826abdbb33f85f59e7bba0777bb781c">setEncoding</a> </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div><p>
<a class="anchor" name="f41aed928b8c023f148d8175faa10e19"></a><!-- doxytag: member="xercesc::DOMWriter::getNewLine" ref="f41aed928b8c023f148d8175faa10e19" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const XMLCh* xercesc::DOMWriter::getNewLine </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the end-of-line sequence of characters to be used in the XML being written out.
<p>
<b>"Experimental - subject to change"</b><p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The end-of-line sequence of characters to be used. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMWriter.html#0522dcac9fee7fbb8b3330456069cf0c">setNewLine</a> </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div><p>
<a class="anchor" name="0c7a1d64d226063fbd290088869434d3"></a><!-- doxytag: member="xercesc::DOMWriter::getErrorHandler" ref="0c7a1d64d226063fbd290088869434d3" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMErrorHandler.html">DOMErrorHandler</a>* xercesc::DOMWriter::getErrorHandler </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the error handler that will receive error notifications during serialization.
<p>
<b>"Experimental - subject to change"</b><p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The error handler to be used. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMWriter.html#4425eaac49c557c7d2ac75b092602bc7">setErrorHandler</a> </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div><p>
<a class="anchor" name="8900ee97b5419fa34f4df616181b42a2"></a><!-- doxytag: member="xercesc::DOMWriter::getFilter" ref="8900ee97b5419fa34f4df616181b42a2" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMWriterFilter.html">DOMWriterFilter</a>* xercesc::DOMWriter::getFilter </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the WriterFilter used.
<p>
<b>"Experimental - subject to change"</b><p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The writer filter used. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classxercesc_1_1DOMWriter.html#ba1e3c9a7be87cd5d816d9d8e9e3f7ad">setFilter</a> </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div><p>
<a class="anchor" name="715500b3f075de6fa53a5bb7e7c3bfcf"></a><!-- doxytag: member="xercesc::DOMWriter::writeNode" ref="715500b3f075de6fa53a5bb7e7c3bfcf" args="(XMLFormatTarget *const destination, const DOMNode &amp;nodeToWrite)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool xercesc::DOMWriter::writeNode </td>
<td>(</td>
<td class="paramtype">XMLFormatTarget *const&nbsp;</td>
<td class="paramname"> <em>destination</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> &amp;&nbsp;</td>
<td class="paramname"> <em>nodeToWrite</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>
Write out the specified node as described above in the description of <code><a class="el" href="classxercesc_1_1DOMWriter.html">DOMWriter</a></code>.
<p>
Writing a Document or Entity node produces a serialized form that is well formed XML. Writing other node types produces a fragment of text in a form that is not fully defined by this document, but that should be useful to a human for debugging or diagnostic purposes.<p>
<b>"Experimental - subject to change"</b><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>destination</em>&nbsp;</td><td>The destination for the data to be written. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nodeToWrite</em>&nbsp;</td><td>The <code>Document</code> or <code>Entity</code> node to be written. For other node types, something sensible should be written, but the exact serialized form is not specified. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns <code>true</code> if <code>node</code> was successfully serialized and <code>false</code> in case a failure occured and the failure wasn't canceled by the error handler. </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div><p>
<a class="anchor" name="1ed776eee2becf0052981ff5968d1349"></a><!-- doxytag: member="xercesc::DOMWriter::writeToString" ref="1ed776eee2becf0052981ff5968d1349" args="(const DOMNode &amp;nodeToWrite)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual XMLCh* xercesc::DOMWriter::writeToString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> &amp;&nbsp;</td>
<td class="paramname"> <em>nodeToWrite</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Serialize the specified node as described above in the description of <code><a class="el" href="classxercesc_1_1DOMWriter.html">DOMWriter</a></code>.
<p>
The result of serializing the node is returned as a string. Writing a Document or Entity node produces a serialized form that is well formed XML. Writing other node types produces a fragment of text in a form that is not fully defined by this document, but that should be useful to a human for debugging or diagnostic purposes.<p>
<b>"Experimental - subject to change"</b><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>nodeToWrite</em>&nbsp;</td><td>The node to be written. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the serialized data, or <code>null</code> in case a failure occured and the failure wasn't canceled by the error handler. The returned string is always in UTF-16. The encoding information available in <a class="el" href="classxercesc_1_1DOMWriter.html">DOMWriter</a> is ignored in <a class="el" href="classxercesc_1_1DOMWriter.html#1ed776eee2becf0052981ff5968d1349">writeToString()</a>. </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div><p>
<a class="anchor" name="641ef60cbd02a6182176343b457ddfc7"></a><!-- doxytag: member="xercesc::DOMWriter::release" ref="641ef60cbd02a6182176343b457ddfc7" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xercesc::DOMWriter::release </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Called to indicate that this Writer is no longer in use and that the implementation may relinquish any resources associated with it.
<p>
Access to a released object will lead to unexpected result.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DOMWriter_8hpp-source.html">DOMWriter.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Apr 28 16:41:30 2008 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.1 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink