source: trunk/doc/html/qdomentity.html@ 190

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

reference documentation added
File size: 6.7 KB
Line 
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:5312 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>QDomEntity 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>QDomEntity Class Reference<br><small>[<a href="xml.html">XML module</a>]</small></h1>
33
34<p>The QDomEntity class represents an XML entity.
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="qdomentity-members.html">List of all member functions.</a>
40<h2>Public Members</h2>
41<ul>
42<li class=fn><a href="#QDomEntity"><b>QDomEntity</b></a> ()</li>
43<li class=fn><a href="#QDomEntity-2"><b>QDomEntity</b></a> ( const&nbsp;QDomEntity&nbsp;&amp;&nbsp;x )</li>
44<li class=fn>QDomEntity &amp; <a href="#operator-eq"><b>operator=</b></a> ( const&nbsp;QDomEntity&nbsp;&amp;&nbsp;x )</li>
45<li class=fn><a href="#~QDomEntity"><b>~QDomEntity</b></a> ()</li>
46<li class=fn>virtual QString <a href="#publicId"><b>publicId</b></a> () const</li>
47<li class=fn>virtual QString <a href="#systemId"><b>systemId</b></a> () const</li>
48<li class=fn>virtual QString <a href="#notationName"><b>notationName</b></a> () const</li>
49<li class=fn>virtual QDomNode::NodeType <a href="#nodeType"><b>nodeType</b></a> () const</li>
50<li class=fn>virtual bool <a href="#isEntity"><b>isEntity</b></a> () const</li>
51</ul>
52<hr><a name="details"></a><h2>Detailed Description</h2>
53
54
55
56The QDomEntity class represents an XML entity.
57
58<p>
59
60<p> This class represents an entity in an XML document, either parsed
61or unparsed. Note that this models the entity itself not the
62entity declaration.
63<p> DOM does not support editing entity nodes; if a user wants to make
64changes to the contents of an entity, every related
65<a href="qdomentityreference.html">QDomEntityReference</a> node must be replaced in the DOM tree by a
66clone of the entity's contents, and then the desired changes must
67be made to each of the clones instead. All the descendents of an
68entity node are read-only.
69<p> An entity node does not have any parent.
70<p> You can access the entity's <a href="#publicId">publicId</a>(), <a href="#systemId">systemId</a>() and
71<a href="#notationName">notationName</a>() when available.
72<p> For further information about the Document Object Model see
73<a href="http://www.w3.org/TR/REC-DOM-Level-1/">http://www.w3.org/TR/REC-DOM-Level-1/</a> and
74<a href="http://www.w3.org/TR/DOM-Level-2-Core/">http://www.w3.org/TR/DOM-Level-2-Core/</a>.
75For a more general introduction of the DOM implementation see the
76<a href="qdomdocument.html">QDomDocument</a> documentation.
77<p>See also <a href="xml-tools.html">XML</a>.
78
79<hr><h2>Member Function Documentation</h2>
80<h3 class=fn><a name="QDomEntity"></a>QDomEntity::QDomEntity ()
81</h3>
82Constructs an empty entity.
83
84<h3 class=fn><a name="QDomEntity-2"></a>QDomEntity::QDomEntity ( const&nbsp;<a href="qdomentity.html">QDomEntity</a>&nbsp;&amp;&nbsp;x )
85</h3>
86Constructs a copy of <em>x</em>.
87<p> The data of the copy is shared (shallow copy): modifying one node
88will also change the other. If you want to make a <a href="shclass.html#deep-copy">deep copy</a>, use
89<a href="qdomnode.html#cloneNode">cloneNode</a>().
90
91<h3 class=fn><a name="~QDomEntity"></a>QDomEntity::~QDomEntity ()
92</h3>
93Destroys the object and frees its resources.
94
95<h3 class=fn>bool <a name="isEntity"></a>QDomEntity::isEntity () const<tt> [virtual]</tt>
96</h3>
97Returns TRUE.
98
99<p>Reimplemented from <a href="qdomnode.html#isEntity">QDomNode</a>.
100<h3 class=fn><a href="qdomnode.html#NodeType-enum">QDomNode::NodeType</a> <a name="nodeType"></a>QDomEntity::nodeType () const<tt> [virtual]</tt>
101</h3>
102Returns <a href="qdomnode.html#NodeType-enum">EntityNode</a>.
103
104<p>Reimplemented from <a href="qdomnode.html#nodeType">QDomNode</a>.
105<h3 class=fn><a href="qstring.html">QString</a> <a name="notationName"></a>QDomEntity::notationName () const<tt> [virtual]</tt>
106</h3>
107For unparsed entities this function returns the name of the
108notation for the entity. For parsed entities this function returns
109<a href="qstring.html#QString-null">QString::null</a>.
110
111<h3 class=fn><a href="qdomentity.html">QDomEntity</a>&nbsp;&amp; <a name="operator-eq"></a>QDomEntity::operator= ( const&nbsp;<a href="qdomentity.html">QDomEntity</a>&nbsp;&amp;&nbsp;x )
112</h3>
113Assigns <em>x</em> to this DOM entity.
114<p> The data of the copy is shared (shallow copy): modifying one node
115will also change the other. If you want to make a <a href="shclass.html#deep-copy">deep copy</a>, use
116<a href="qdomnode.html#cloneNode">cloneNode</a>().
117
118<h3 class=fn><a href="qstring.html">QString</a> <a name="publicId"></a>QDomEntity::publicId () const<tt> [virtual]</tt>
119</h3>
120Returns the public identifier associated with this entity. If the
121public identifier was not specified <a href="qstring.html#QString-null">QString::null</a> is returned.
122
123<h3 class=fn><a href="qstring.html">QString</a> <a name="systemId"></a>QDomEntity::systemId () const<tt> [virtual]</tt>
124</h3>
125Returns the system identifier associated with this entity. If the
126system identifier was not specified <a href="qstring.html#QString-null">QString::null</a> is returned.
127
128<!-- eof -->
129<hr><p>
130This file is part of the <a href="index.html">Qt toolkit</a>.
131Copyright &copy; 1995-2007
132<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
133<table width=100% cellspacing=0 border=0><tr>
134<td>Copyright &copy; 2007
135<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
136<td align=right><div align=right>Qt 3.3.8</div>
137</table></div></address></body>
138</html>
Note: See TracBrowser for help on using the repository browser.