source: trunk/doc/html/qdomattr.html

Last change on this file was 190, checked in by rudi, 14 years ago

reference documentation added
File size: 8.2 KB
RevLine 
[190]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/xml/qdom.cpp:3717 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>QDomAttr Class</title>
7<style type="text/css"><!--
8fn { margin-left: 1cm; text-indent: -1cm; }
9a:link { color: #004faf; text-decoration: none }
10a:visited { color: #672967; text-decoration: none }
11body { background: #ffffff; color: black; }
12--></style>
13</head>
14<body>
15
16<table border="0" cellpadding="0" cellspacing="0" width="100%">
17<tr bgcolor="#E5E5E5">
18<td valign=center>
19 <a href="index.html">
20<font color="#004faf">Home</font></a>
21 | <a href="classes.html">
22<font color="#004faf">All&nbsp;Classes</font></a>
23 | <a href="mainclasses.html">
24<font color="#004faf">Main&nbsp;Classes</font></a>
25 | <a href="annotated.html">
26<font color="#004faf">Annotated</font></a>
27 | <a href="groups.html">
28<font color="#004faf">Grouped&nbsp;Classes</font></a>
29 | <a href="functions.html">
30<font color="#004faf">Functions</font></a>
31</td>
32<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QDomAttr Class Reference<br><small>[<a href="xml.html">XML module</a>]</small></h1>
33
34<p>The QDomAttr class represents one attribute of a QDomElement.
35<a href="#details">More...</a>
36<p>All the functions in this class are <a href="threads.html#reentrant">reentrant</a> when Qt is built with thread support.</p>
37<p><tt>#include &lt;<a href="qdom-h.html">qdom.h</a>&gt;</tt>
38<p>Inherits <a href="qdomnode.html">QDomNode</a>.
39<p><a href="qdomattr-members.html">List of all member functions.</a>
40<h2>Public Members</h2>
41<ul>
42<li class=fn><a href="#QDomAttr"><b>QDomAttr</b></a> ()</li>
43<li class=fn><a href="#QDomAttr-2"><b>QDomAttr</b></a> ( const&nbsp;QDomAttr&nbsp;&amp;&nbsp;x )</li>
44<li class=fn>QDomAttr &amp; <a href="#operator-eq"><b>operator=</b></a> ( const&nbsp;QDomAttr&nbsp;&amp;&nbsp;x )</li>
45<li class=fn><a href="#~QDomAttr"><b>~QDomAttr</b></a> ()</li>
46<li class=fn>virtual QString <a href="#name"><b>name</b></a> () const</li>
47<li class=fn>virtual bool <a href="#specified"><b>specified</b></a> () const</li>
48<li class=fn>virtual QDomElement <a href="#ownerElement"><b>ownerElement</b></a> () const</li>
49<li class=fn>virtual QString <a href="#value"><b>value</b></a> () const</li>
50<li class=fn>virtual void <a href="#setValue"><b>setValue</b></a> ( const&nbsp;QString&nbsp;&amp;&nbsp;v )</li>
51<li class=fn>virtual QDomNode::NodeType <a href="#nodeType"><b>nodeType</b></a> () const</li>
52<li class=fn>virtual bool <a href="#isAttr"><b>isAttr</b></a> () const</li>
53</ul>
54<hr><a name="details"></a><h2>Detailed Description</h2>
55
56
57
58The QDomAttr class represents one attribute of a <a href="qdomelement.html">QDomElement</a>.
59
60<p>
61
62<p> For example, the following piece of XML produces an element with
63no children, but two attributes:
64<p> <pre>
65 &lt;link href="http://www.trolltech.com" color="red" /&gt;
66 </pre>
67
68<p> You can access the attributes of an element with code like this:
69<p> <pre>
70 <a href="qdomelement.html">QDomElement</a> e = //...
71 //...
72 QDomAttr a = e.<a href="qdomelement.html#attributeNode">attributeNode</a>( "href" );
73 cout &lt;&lt; a.<a href="#value">value</a>() &lt;&lt; endl; // prints "http://www.trolltech.com"
74 a.<a href="#setValue">setValue</a>( "http://doc.trolltech.com" ); // change the node's attribute
75 QDomAttr a2 = e.<a href="qdomelement.html#attributeNode">attributeNode</a>( "href" );
76 cout &lt;&lt; a2.<a href="#value">value</a>() &lt;&lt; endl; // prints "http://doc.trolltech.com"
77 </pre>
78
79<p> This example also shows that changing an attribute received from
80an element changes the attribute of the element. If you do not
81want to change the value of the element's attribute you must
82use <a href="qdomnode.html#cloneNode">cloneNode</a>() to get an independent copy of the attribute.
83<p> QDomAttr can return the <a href="#name">name</a>() and <a href="#value">value</a>() of an attribute. An
84attribute's value is set with <a href="#setValue">setValue</a>(). If <a href="#specified">specified</a>() returns
85TRUE the value was either set in the document or set with
86setValue(); otherwise the value hasn't been set. The node this
87attribute is attached to (if any) is returned by <a href="#ownerElement">ownerElement</a>().
88<p> For further information about the Document Object Model see
89<a href="http://www.w3.org/TR/REC-DOM-Level-1/">http://www.w3.org/TR/REC-DOM-Level-1/</a> and
90<a href="http://www.w3.org/TR/DOM-Level-2-Core/">http://www.w3.org/TR/DOM-Level-2-Core/</a>.
91For a more general introduction of the DOM implementation see the
92<a href="qdomdocument.html">QDomDocument</a> documentation.
93<p>See also <a href="xml-tools.html">XML</a>.
94
95<hr><h2>Member Function Documentation</h2>
96<h3 class=fn><a name="QDomAttr"></a>QDomAttr::QDomAttr ()
97</h3>
98Constructs an empty attribute.
99
100<h3 class=fn><a name="QDomAttr-2"></a>QDomAttr::QDomAttr ( const&nbsp;<a href="qdomattr.html">QDomAttr</a>&nbsp;&amp;&nbsp;x )
101</h3>
102Constructs a copy of <em>x</em>.
103<p> The data of the copy is shared (shallow copy): modifying one node
104will also change the other. If you want to make a <a href="shclass.html#deep-copy">deep copy</a>, use
105<a href="qdomnode.html#cloneNode">cloneNode</a>().
106
107<h3 class=fn><a name="~QDomAttr"></a>QDomAttr::~QDomAttr ()
108</h3>
109Destroys the object and frees its resources.
110
111<h3 class=fn>bool <a name="isAttr"></a>QDomAttr::isAttr () const<tt> [virtual]</tt>
112</h3>
113Returns TRUE.
114
115<p>Reimplemented from <a href="qdomnode.html#isAttr">QDomNode</a>.
116<h3 class=fn><a href="qstring.html">QString</a> <a name="name"></a>QDomAttr::name () const<tt> [virtual]</tt>
117</h3>
118Returns the attribute's name.
119
120<h3 class=fn><a href="qdomnode.html#NodeType-enum">QDomNode::NodeType</a> <a name="nodeType"></a>QDomAttr::nodeType () const<tt> [virtual]</tt>
121</h3>
122Returns <a href="qdomnode.html#NodeType-enum">AttributeNode</a>.
123
124<p>Reimplemented from <a href="qdomnode.html#nodeType">QDomNode</a>.
125<h3 class=fn><a href="qdomattr.html">QDomAttr</a>&nbsp;&amp; <a name="operator-eq"></a>QDomAttr::operator= ( const&nbsp;<a href="qdomattr.html">QDomAttr</a>&nbsp;&amp;&nbsp;x )
126</h3>
127Assigns <em>x</em> to this DOM attribute.
128<p> The data of the copy is shared (shallow copy): modifying one node
129will also change the other. If you want to make a <a href="shclass.html#deep-copy">deep copy</a>, use
130<a href="qdomnode.html#cloneNode">cloneNode</a>().
131
132<h3 class=fn><a href="qdomelement.html">QDomElement</a> <a name="ownerElement"></a>QDomAttr::ownerElement () const<tt> [virtual]</tt>
133</h3>
134Returns the element node this attribute is attached to or a <a href="qdomnode.html#isNull">null node</a> if this attribute is not
135attached to any element.
136
137<h3 class=fn>void <a name="setValue"></a>QDomAttr::setValue ( const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;v )<tt> [virtual]</tt>
138</h3>
139Sets the attribute's value to <em>v</em>.
140<p> <p>See also <a href="#value">value</a>().
141
142<h3 class=fn>bool <a name="specified"></a>QDomAttr::specified () const<tt> [virtual]</tt>
143</h3>
144Returns TRUE if the attribute has either been expicitly specified
145in the XML document or was set by the user with <a href="#setValue">setValue</a>().
146Returns FALSE if the value hasn't been specified or set.
147<p> <p>See also <a href="#setValue">setValue</a>().
148
149<h3 class=fn><a href="qstring.html">QString</a> <a name="value"></a>QDomAttr::value () const<tt> [virtual]</tt>
150</h3>
151Returns the value of the attribute or <a href="qstring.html#QString-null">QString::null</a> if the
152attribute has not been specified.
153<p> <p>See also <a href="#specified">specified</a>() and <a href="#setValue">setValue</a>().
154
155<!-- eof -->
156<hr><p>
157This file is part of the <a href="index.html">Qt toolkit</a>.
158Copyright &copy; 1995-2007
159<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
160<table width=100% cellspacing=0 border=0><tr>
161<td>Copyright &copy; 2007
162<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
163<td align=right><div align=right>Qt 3.3.8</div>
164</table></div></address></body>
165</html>
Note: See TracBrowser for help on using the repository browser.