mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
XQuilla/docs/dom3-api/classxercesc_1_1DOMText.html
King_DuckZ 9341942014 v2.1.1
2020-02-17 22:13:50 +01:00

335 lines
20 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_1DOMText.html">DOMText</a></div>
<h1>xercesc::DOMText Class Reference</h1><!-- doxytag: class="xercesc::DOMText" --><!-- doxytag: inherits="xercesc::DOMCharacterData" -->The <code><a class="el" href="classxercesc_1_1DOMText.html">DOMText</a></code> interface inherits from <code><a class="el" href="classxercesc_1_1DOMCharacterData.html">DOMCharacterData</a></code> and represents the textual content (termed character data in XML) of an <code><a class="el" href="classxercesc_1_1DOMElement.html">DOMElement</a></code> or <code><a class="el" href="classxercesc_1_1DOMAttr.html">DOMAttr</a></code>.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="DOMText_8hpp-source.html">DOMText.hpp</a>&gt;</code>
<p>
Inheritance diagram for xercesc::DOMText:<p><center><img src="classxercesc_1_1DOMText__inherit__graph.png" border="0" usemap="#xercesc_1_1DOMText__inherit__map" alt="Inheritance graph"></center>
<map name="xercesc_1_1DOMText__inherit__map">
<area href="classxercesc_1_1DOMCDATASection.html" shape="rect" coords="8,231,216,255" alt="">
<area href="classxercesc_1_1DOMCharacterData.html" shape="rect" coords="5,81,219,105" alt="">
<area href="classxercesc_1_1DOMNode.html" shape="rect" coords="37,7,187,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classxercesc_1_1DOMText-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 1</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMText.html">DOMText</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMText.html#e25fed1933ce34f3565c5e6e741b6410">splitText</a> (XMLSize_t offset)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Breaks this node into two nodes at the specified <code>offset</code>, keeping both in the tree as siblings. <a href="#e25fed1933ce34f3565c5e6e741b6410"></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 bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMText.html#3edbecf87944d101aa622a7736545fad">getIsWhitespaceInElementContent</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether this text node contains whitespace in element content, often abusively called "ignorable whitespace". <a href="#3edbecf87944d101aa622a7736545fad"></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_1DOMText.html#d62c49475e1c883fe7a4f2e736a28521">getWholeText</a> ()=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns all text of <code><a class="el" href="classxercesc_1_1DOMText.html">DOMText</a></code> nodes logically-adjacent text nodes to this node, concatenated in document order. <a href="#d62c49475e1c883fe7a4f2e736a28521"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMText.html">DOMText</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMText.html#d9012bf661d361e98c1006b49d07c394">replaceWholeText</a> (const XMLCh *content)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Substitutes the a specified text for the text of the current node and all logically-adjacent text nodes. <a href="#d9012bf661d361e98c1006b49d07c394"></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 bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMText.html#4eae9cdd813f5f746b17ce07b461cc0e">isIgnorableWhitespace</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Non-standard extension. <a href="#4eae9cdd813f5f746b17ce07b461cc0e"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <code><a class="el" href="classxercesc_1_1DOMText.html">DOMText</a></code> interface inherits from <code><a class="el" href="classxercesc_1_1DOMCharacterData.html">DOMCharacterData</a></code> and represents the textual content (termed character data in XML) of an <code><a class="el" href="classxercesc_1_1DOMElement.html">DOMElement</a></code> or <code><a class="el" href="classxercesc_1_1DOMAttr.html">DOMAttr</a></code>.
<p>
If there is no markup inside an element's content, the text is contained in a single object implementing the <code><a class="el" href="classxercesc_1_1DOMText.html">DOMText</a></code> interface that is the only child of the element. If there is markup, it is parsed into the information items (elements, comments, etc.) and <code><a class="el" href="classxercesc_1_1DOMText.html">DOMText</a></code> nodes that form the list of children of the element. <p>
When a document is first made available via the DOM, there is only one <code><a class="el" href="classxercesc_1_1DOMText.html">DOMText</a></code> node for each block of text. Users may create adjacent <code><a class="el" href="classxercesc_1_1DOMText.html">DOMText</a></code> nodes that represent the contents of a given element without any intervening markup, but should be aware that there is no way to represent the separations between these nodes in XML or HTML, so they will not (in general) persist between DOM editing sessions. The <code><a class="el" href="classxercesc_1_1DOMNode.html#98d4e1ca99342ae7fa64ffcb1731b1e9">normalize()</a></code> method on <code><a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a></code> merges any such adjacent <code><a class="el" href="classxercesc_1_1DOMText.html">DOMText</a></code> objects into a single node for each block of text. <p>
See also the <a href="http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113">Document Object Model (DOM) Level 2 Core Specification</a>.
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a69f974d33e531160fd595cd8e8e2029"></a><!-- doxytag: member="xercesc::DOMText::DOMText" ref="a69f974d33e531160fd595cd8e8e2029" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::DOMText::DOMText </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="2ca3f821b118667eeedc81e10e63f6e9"></a><!-- doxytag: member="xercesc::DOMText::DOMText" ref="2ca3f821b118667eeedc81e10e63f6e9" args="(const DOMText &amp;other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::DOMText::DOMText </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classxercesc_1_1DOMText.html">DOMText</a> &amp;&nbsp;</td>
<td class="paramname"> <em>other</em> </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="02d158aae55600b58e584452acf92a04"></a><!-- doxytag: member="xercesc::DOMText::~DOMText" ref="02d158aae55600b58e584452acf92a04" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual xercesc::DOMText::~DOMText </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="a69f974d33e531160fd595cd8e8e2029"></a><!-- doxytag: member="xercesc::DOMText::DOMText" ref="a69f974d33e531160fd595cd8e8e2029" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::DOMText::DOMText </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="2ca3f821b118667eeedc81e10e63f6e9"></a><!-- doxytag: member="xercesc::DOMText::DOMText" ref="2ca3f821b118667eeedc81e10e63f6e9" args="(const DOMText &amp;other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::DOMText::DOMText </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classxercesc_1_1DOMText.html">DOMText</a> &amp;&nbsp;</td>
<td class="paramname"> <em>other</em> </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="02d158aae55600b58e584452acf92a04"></a><!-- doxytag: member="xercesc::DOMText::~DOMText" ref="02d158aae55600b58e584452acf92a04" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual xercesc::DOMText::~DOMText </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="e25fed1933ce34f3565c5e6e741b6410"></a><!-- doxytag: member="xercesc::DOMText::splitText" ref="e25fed1933ce34f3565c5e6e741b6410" args="(XMLSize_t offset)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMText.html">DOMText</a>* xercesc::DOMText::splitText </td>
<td>(</td>
<td class="paramtype">XMLSize_t&nbsp;</td>
<td class="paramname"> <em>offset</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Breaks this node into two nodes at the specified <code>offset</code>, keeping both in the tree as siblings.
<p>
After being split, this node will contain all the content up to the <code>offset</code> point. A new node of the same type, which contains all the content at and after the <code>offset</code> point, is returned. If the original node had a parent node, the new node is inserted as the next sibling of the original node. When the <code>offset</code> is equal to the length of this node, the new node has no data. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>offset</em>&nbsp;</td><td>The 16-bit unit offset at which to split, starting from <code>0</code>. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The new node, of the same type as this node. </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>INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in <code>data</code>. <br>
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. </td></tr>
</table>
</dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 1 </dd></dl>
</div>
</div><p>
<a class="anchor" name="3edbecf87944d101aa622a7736545fad"></a><!-- doxytag: member="xercesc::DOMText::getIsWhitespaceInElementContent" ref="3edbecf87944d101aa622a7736545fad" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool xercesc::DOMText::getIsWhitespaceInElementContent </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>
Returns whether this text node contains whitespace in element content, often abusively called "ignorable whitespace".
<p>
An implementation can only return <code>true</code> if, one way or another, it has access to the relevant information (e.g., the DTD or schema).<p>
<b>"Experimental - subject to change"</b><p>
<br>
This attribute represents the property [element content whitespace] defined in . <dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div><p>
<a class="anchor" name="d62c49475e1c883fe7a4f2e736a28521"></a><!-- doxytag: member="xercesc::DOMText::getWholeText" ref="d62c49475e1c883fe7a4f2e736a28521" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const XMLCh* xercesc::DOMText::getWholeText </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>
Returns all text of <code><a class="el" href="classxercesc_1_1DOMText.html">DOMText</a></code> nodes logically-adjacent text nodes to this node, concatenated in document order.
<p>
<b>"Experimental - subject to change"</b><p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div><p>
<a class="anchor" name="d9012bf661d361e98c1006b49d07c394"></a><!-- doxytag: member="xercesc::DOMText::replaceWholeText" ref="d9012bf661d361e98c1006b49d07c394" args="(const XMLCh *content)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMText.html">DOMText</a>* xercesc::DOMText::replaceWholeText </td>
<td>(</td>
<td class="paramtype">const XMLCh *&nbsp;</td>
<td class="paramname"> <em>content</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Substitutes the a specified text for the text of the current node and all logically-adjacent text nodes.
<p>
<b>"Experimental - subject to change"</b><p>
<br>
This method returns the node in the hierarchy which received the replacement text, which is null if the text was empty or is the current node if the current node is not read-only or otherwise is a new node of the same type as the current node inserted at the site of the replacement. All logically-adjacent text nodes are removed including the current node unless it was the recipient of the replacement text. <br>
Where the nodes to be removed are read-only descendants of an <code><a class="el" href="classxercesc_1_1DOMEntityReference.html">DOMEntityReference</a></code>, the <code><a class="el" href="classxercesc_1_1DOMEntityReference.html">DOMEntityReference</a></code> must be removed instead of the read-only nodes. If any <code><a class="el" href="classxercesc_1_1DOMEntityReference.html">DOMEntityReference</a></code> to be removed has descendants that are not <code><a class="el" href="classxercesc_1_1DOMEntityReference.html">DOMEntityReference</a></code>, <code><a class="el" href="classxercesc_1_1DOMText.html">DOMText</a></code>, or <code><a class="el" href="classxercesc_1_1DOMCDATASection.html">DOMCDATASection</a></code> nodes, the <code>replaceWholeText</code> method must fail before performing any modification of the document, raising a <code><a class="el" href="classxercesc_1_1DOMException.html">DOMException</a></code> with the code <code>NO_MODIFICATION_ALLOWED_ERR</code>. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>content</em>&nbsp;</td><td>The content of the replacing <code><a class="el" href="classxercesc_1_1DOMText.html">DOMText</a></code> node. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The <code><a class="el" href="classxercesc_1_1DOMText.html">DOMText</a></code> node created with the specified content. </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>NO_MODIFICATION_ALLOWED_ERR: Raised if one of the <code><a class="el" href="classxercesc_1_1DOMText.html">DOMText</a></code> nodes being replaced is readonly. </td></tr>
</table>
</dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
</div>
</div><p>
<a class="anchor" name="4eae9cdd813f5f746b17ce07b461cc0e"></a><!-- doxytag: member="xercesc::DOMText::isIgnorableWhitespace" ref="4eae9cdd813f5f746b17ce07b461cc0e" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool xercesc::DOMText::isIgnorableWhitespace </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>
Non-standard extension.
<p>
Return true if this node contains ignorable whitespaces only. <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if this node contains ignorable whitespaces only. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DOMText_8hpp-source.html">DOMText.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Apr 8 14:29:46 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