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

364 lines
18 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_1DOMAttr.html">DOMAttr</a></div>
<h1>xercesc::DOMAttr Class Reference</h1><!-- doxytag: class="xercesc::DOMAttr" --><!-- doxytag: inherits="xercesc::DOMNode" -->The <code><a class="el" href="classxercesc_1_1DOMAttr.html">DOMAttr</a></code> class refers to an attribute of an XML element.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="DOMAttr_8hpp-source.html">DOMAttr.hpp</a>&gt;</code>
<p>
Inheritance diagram for xercesc::DOMAttr:<p><center><img src="classxercesc_1_1DOMAttr__inherit__graph.png" border="0" usemap="#xercesc_1_1DOMAttr__inherit__map" alt="Inheritance graph"></center>
<map name="xercesc_1_1DOMAttr__inherit__map">
<area href="classxercesc_1_1DOMNode.html" shape="rect" coords="5,7,155,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classxercesc_1_1DOMAttr-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 const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMAttr.html#bd775ac0b65243ac2933931c17f820e0">getName</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the name of this attribute. <a href="#bd775ac0b65243ac2933931c17f820e0"></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_1DOMAttr.html#ab6fa80522e75795e619e591a6257393">getSpecified</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the attribute received its value explicitly in the XML document, or if a value was assigned programatically with the setValue function. <a href="#ab6fa80522e75795e619e591a6257393"></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_1DOMAttr.html#cc0f9c5f10219b99d8579af402e2df39">getValue</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the value of the attribute. <a href="#cc0f9c5f10219b99d8579af402e2df39"></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_1DOMAttr.html#38304e6e8a0d93ac3ff32b9f059ea2d8">setValue</a> (const XMLCh *value)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the value of the attribute. <a href="#38304e6e8a0d93ac3ff32b9f059ea2d8"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 2.</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMElement.html">DOMElement</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMAttr.html#31fad379a6e02a35a0d028fe0b361f52">getOwnerElement</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The <code><a class="el" href="classxercesc_1_1DOMElement.html">DOMElement</a></code> node this attribute is attached to or <code>null</code> if this attribute is not in use. <a href="#31fad379a6e02a35a0d028fe0b361f52"></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_1DOMAttr.html#ffcfe285670a1c13739df73a04c6fe92">isId</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether this attribute is known to be of type ID or not. <a href="#ffcfe285670a1c13739df73a04c6fe92"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classxercesc_1_1DOMTypeInfo.html">DOMTypeInfo</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMAttr.html#97dd767a43f86242448d132703c8c820">getTypeInfo</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the type information associated with this attribute. <a href="#97dd767a43f86242448d132703c8c820"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <code><a class="el" href="classxercesc_1_1DOMAttr.html">DOMAttr</a></code> class refers to an attribute of an XML element.
<p>
Typically the allowable values for the attribute are defined in a documenttype definition. <p>
<code><a class="el" href="classxercesc_1_1DOMAttr.html">DOMAttr</a></code> objects inherit the <code><a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a></code> interface, but since attributes are not actually child nodes of the elements they are associated with, the DOM does not consider them part of the document tree. Thus, the <code><a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a></code> attributes <code>parentNode</code>, <code>previousSibling</code>, and <code>nextSibling</code> have a null value for <code><a class="el" href="classxercesc_1_1DOMAttr.html">DOMAttr</a></code> objects. The DOM takes the view that attributes are properties of elements rather than having a separate identity from the elements they are associated with; this should make it more efficient to implement such features as default attributes associated with all elements of a given type. Furthermore, attribute nodes may not be immediate children of a <code><a class="el" href="classxercesc_1_1DOMDocumentFragment.html">DOMDocumentFragment</a></code>. However, they can be associated with <code><a class="el" href="classxercesc_1_1DOMElement.html">DOMElement</a></code> nodes contained within a <code><a class="el" href="classxercesc_1_1DOMDocumentFragment.html">DOMDocumentFragment</a></code>. In short, users of the DOM need to be aware that <code><a class="el" href="classxercesc_1_1DOMAttr.html">DOMAttr</a></code> nodes have some things in common with other objects inheriting the <code><a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a></code> interface, but they also are quite distinct.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 1 </dd></dl>
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="f22e3ac423ed416f507f67e99e4a6749"></a><!-- doxytag: member="xercesc::DOMAttr::DOMAttr" ref="f22e3ac423ed416f507f67e99e4a6749" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::DOMAttr::DOMAttr </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="2e6e731c03f10a3c8116549556ca2b50"></a><!-- doxytag: member="xercesc::DOMAttr::DOMAttr" ref="2e6e731c03f10a3c8116549556ca2b50" args="(const DOMAttr &amp;other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::DOMAttr::DOMAttr </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classxercesc_1_1DOMAttr.html">DOMAttr</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="92f914d9871b78a61bc70997a01eced8"></a><!-- doxytag: member="xercesc::DOMAttr::~DOMAttr" ref="92f914d9871b78a61bc70997a01eced8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual xercesc::DOMAttr::~DOMAttr </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="f22e3ac423ed416f507f67e99e4a6749"></a><!-- doxytag: member="xercesc::DOMAttr::DOMAttr" ref="f22e3ac423ed416f507f67e99e4a6749" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::DOMAttr::DOMAttr </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="2e6e731c03f10a3c8116549556ca2b50"></a><!-- doxytag: member="xercesc::DOMAttr::DOMAttr" ref="2e6e731c03f10a3c8116549556ca2b50" args="(const DOMAttr &amp;other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::DOMAttr::DOMAttr </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classxercesc_1_1DOMAttr.html">DOMAttr</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="92f914d9871b78a61bc70997a01eced8"></a><!-- doxytag: member="xercesc::DOMAttr::~DOMAttr" ref="92f914d9871b78a61bc70997a01eced8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual xercesc::DOMAttr::~DOMAttr </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="bd775ac0b65243ac2933931c17f820e0"></a><!-- doxytag: member="xercesc::DOMAttr::getName" ref="bd775ac0b65243ac2933931c17f820e0" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const XMLCh* xercesc::DOMAttr::getName </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 the name of this attribute.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 1 </dd></dl>
</div>
</div><p>
<a class="anchor" name="ab6fa80522e75795e619e591a6257393"></a><!-- doxytag: member="xercesc::DOMAttr::getSpecified" ref="ab6fa80522e75795e619e591a6257393" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool xercesc::DOMAttr::getSpecified </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 true if the attribute received its value explicitly in the XML document, or if a value was assigned programatically with the setValue function.
<p>
Returns false if the attribute value came from the default value declared in the document's DTD. <dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 1 </dd></dl>
</div>
</div><p>
<a class="anchor" name="cc0f9c5f10219b99d8579af402e2df39"></a><!-- doxytag: member="xercesc::DOMAttr::getValue" ref="cc0f9c5f10219b99d8579af402e2df39" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const XMLCh* xercesc::DOMAttr::getValue </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 the value of the attribute.
<p>
The value of the attribute is returned as a string. Character and general entity references are replaced with their values. <dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 1 </dd></dl>
</div>
</div><p>
<a class="anchor" name="38304e6e8a0d93ac3ff32b9f059ea2d8"></a><!-- doxytag: member="xercesc::DOMAttr::setValue" ref="38304e6e8a0d93ac3ff32b9f059ea2d8" args="(const XMLCh *value)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xercesc::DOMAttr::setValue </td>
<td>(</td>
<td class="paramtype">const XMLCh *&nbsp;</td>
<td class="paramname"> <em>value</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the value of the attribute.
<p>
A text node with the unparsed contents of the string will be created.<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>value</em>&nbsp;</td><td>The value of the DOM attribute to be set </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="31fad379a6e02a35a0d028fe0b361f52"></a><!-- doxytag: member="xercesc::DOMAttr::getOwnerElement" ref="31fad379a6e02a35a0d028fe0b361f52" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMElement.html">DOMElement</a>* xercesc::DOMAttr::getOwnerElement </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>
The <code><a class="el" href="classxercesc_1_1DOMElement.html">DOMElement</a></code> node this attribute is attached to or <code>null</code> if this attribute is not in use.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 2 </dd></dl>
</div>
</div><p>
<a class="anchor" name="ffcfe285670a1c13739df73a04c6fe92"></a><!-- doxytag: member="xercesc::DOMAttr::isId" ref="ffcfe285670a1c13739df73a04c6fe92" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool xercesc::DOMAttr::isId </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 attribute is known to be of type ID or not.
<p>
When it is and its value is unique, the ownerElement of this attribute can be retrieved using getElementById on Document.<p>
<b>"Experimental - subject to change"</b><p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>bool</code> stating if this <code><a class="el" href="classxercesc_1_1DOMAttr.html">DOMAttr</a></code> is an ID </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM level 3 </dd></dl>
</div>
</div><p>
<a class="anchor" name="97dd767a43f86242448d132703c8c820"></a><!-- doxytag: member="xercesc::DOMAttr::getTypeInfo" ref="97dd767a43f86242448d132703c8c820" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classxercesc_1_1DOMTypeInfo.html">DOMTypeInfo</a>* xercesc::DOMAttr::getTypeInfo </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 the type information associated with this attribute.
<p>
<b>"Experimental - subject to change"</b><p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the <code><a class="el" href="classxercesc_1_1DOMTypeInfo.html">DOMTypeInfo</a></code> associated with this attribute </dd></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="DOMAttr_8hpp-source.html">DOMAttr.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Apr 8 14:29:45 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