summaryrefslogtreecommitdiffstats
path: root/doc/html/qdomattr.html
blob: d26279f3143a267d28dc16fb7c669cdca6a30cc4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/xml/qdom.cpp:3717 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QDomAttr Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<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>

<p>The QDomAttr class represents one attribute of a QDomElement.
<a href="#details">More...</a>
<p>All the functions in this class are <a href="threads.html#reentrant">reentrant</a> when Qt is built with thread support.</p>
<p><tt>#include &lt;<a href="qdom-h.html">qdom.h</a>&gt;</tt>
<p>Inherits <a href="qdomnode.html">QDomNode</a>.
<p><a href="qdomattr-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#QDomAttr"><b>QDomAttr</b></a> ()</li>
<li class=fn><a href="#QDomAttr-2"><b>QDomAttr</b></a> ( const&nbsp;QDomAttr&nbsp;&amp;&nbsp;x )</li>
<li class=fn>QDomAttr &amp; <a href="#operator-eq"><b>operator=</b></a> ( const&nbsp;QDomAttr&nbsp;&amp;&nbsp;x )</li>
<li class=fn><a href="#~QDomAttr"><b>~QDomAttr</b></a> ()</li>
<li class=fn>virtual QString <a href="#name"><b>name</b></a> () const</li>
<li class=fn>virtual bool <a href="#specified"><b>specified</b></a> () const</li>
<li class=fn>virtual QDomElement <a href="#ownerElement"><b>ownerElement</b></a> () const</li>
<li class=fn>virtual QString <a href="#value"><b>value</b></a> () const</li>
<li class=fn>virtual void <a href="#setValue"><b>setValue</b></a> ( const&nbsp;QString&nbsp;&amp;&nbsp;v )</li>
<li class=fn>virtual QDomNode::NodeType <a href="#nodeType"><b>nodeType</b></a> () const</li>
<li class=fn>virtual bool <a href="#isAttr"><b>isAttr</b></a> () const</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>



The QDomAttr class represents one attribute of a <a href="qdomelement.html">QDomElement</a>.

<p> 

<p> For example, the following piece of XML produces an element with
no children, but two attributes:
<p> <pre>
    &lt;link href="http://www.trolltech.com" color="red" /&gt;
    </pre>
 
<p> You can access the attributes of an element with code like this:
<p> <pre>
    <a href="qdomelement.html">QDomElement</a> e = //...
    //...
    QDomAttr a = e.<a href="qdomelement.html#attributeNode">attributeNode</a>( "href" );
    cout &lt;&lt; a.<a href="#value">value</a>() &lt;&lt; endl;                // prints "http://www.trolltech.com"
    a.<a href="#setValue">setValue</a>( "http://doc.trolltech.com" ); // change the node's attribute
    QDomAttr a2 = e.<a href="qdomelement.html#attributeNode">attributeNode</a>( "href" );
    cout &lt;&lt; a2.<a href="#value">value</a>() &lt;&lt; endl;               // prints "http://doc.trolltech.com"
    </pre>
 
<p> This example also shows that changing an attribute received from
an element changes the attribute of the element. If you do not
want to change the value of the element's attribute you must
use <a href="qdomnode.html#cloneNode">cloneNode</a>() to get an independent copy of the attribute.
<p> QDomAttr can return the <a href="#name">name</a>() and <a href="#value">value</a>() of an attribute. An
attribute's value is set with <a href="#setValue">setValue</a>(). If <a href="#specified">specified</a>() returns
TRUE the value was either set in the document or set with
setValue(); otherwise the value hasn't been set. The node this
attribute is attached to (if any) is returned by <a href="#ownerElement">ownerElement</a>().
<p> For further information about the Document Object Model see
<a href="http://www.w3.org/TR/REC-DOM-Level-1/">http://www.w3.org/TR/REC-DOM-Level-1/</a> and
<a href="http://www.w3.org/TR/DOM-Level-2-Core/">http://www.w3.org/TR/DOM-Level-2-Core/</a>.
For a more general introduction of the DOM implementation see the
<a href="qdomdocument.html">QDomDocument</a> documentation.
<p>See also <a href="xml-tools.html">XML</a>.

<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QDomAttr"></a>QDomAttr::QDomAttr ()
</h3>
Constructs an empty attribute.

<h3 class=fn><a name="QDomAttr-2"></a>QDomAttr::QDomAttr ( const&nbsp;<a href="qdomattr.html">QDomAttr</a>&nbsp;&amp;&nbsp;x )
</h3>
Constructs a copy of <em>x</em>.
<p> The data of the copy is shared (shallow copy): modifying one node
will also change the other. If you want to make a <a href="shclass.html#deep-copy">deep copy</a>, use
<a href="qdomnode.html#cloneNode">cloneNode</a>().

<h3 class=fn><a name="~QDomAttr"></a>QDomAttr::~QDomAttr ()
</h3>
Destroys the object and frees its resources.

<h3 class=fn>bool <a name="isAttr"></a>QDomAttr::isAttr () const<tt> [virtual]</tt>
</h3>
Returns TRUE.

<p>Reimplemented from <a href="qdomnode.html#isAttr">QDomNode</a>.
<h3 class=fn><a href="qstring.html">QString</a> <a name="name"></a>QDomAttr::name () const<tt> [virtual]</tt>
</h3>
Returns the attribute's name.

<h3 class=fn><a href="qdomnode.html#NodeType-enum">QDomNode::NodeType</a> <a name="nodeType"></a>QDomAttr::nodeType () const<tt> [virtual]</tt>
</h3>
Returns <a href="qdomnode.html#NodeType-enum">AttributeNode</a>.

<p>Reimplemented from <a href="qdomnode.html#nodeType">QDomNode</a>.
<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 )
</h3>
Assigns <em>x</em> to this DOM attribute.
<p> The data of the copy is shared (shallow copy): modifying one node
will also change the other. If you want to make a <a href="shclass.html#deep-copy">deep copy</a>, use
<a href="qdomnode.html#cloneNode">cloneNode</a>().

<h3 class=fn><a href="qdomelement.html">QDomElement</a> <a name="ownerElement"></a>QDomAttr::ownerElement () const<tt> [virtual]</tt>
</h3>
Returns the element node this attribute is attached to or a <a href="qdomnode.html#isNull">null node</a> if this attribute is not
attached to any element.

<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>
</h3>
Sets the attribute's value to <em>v</em>.
<p> <p>See also <a href="#value">value</a>().

<h3 class=fn>bool <a name="specified"></a>QDomAttr::specified () const<tt> [virtual]</tt>
</h3>
Returns TRUE if the attribute has either been expicitly specified
in the XML document or was set by the user with <a href="#setValue">setValue</a>().
Returns FALSE if the value hasn't been specified or set.
<p> <p>See also <a href="#setValue">setValue</a>().

<h3 class=fn><a href="qstring.html">QString</a> <a name="value"></a>QDomAttr::value () const<tt> [virtual]</tt>
</h3>
Returns the value of the attribute or <a href="qstring.html#QString-null">QString::null</a> if the
attribute has not been specified.
<p> <p>See also <a href="#specified">specified</a>() and <a href="#setValue">setValue</a>().

<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright &copy; 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>