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

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

reference documentation added

File size: 6.2 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:5486 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>QDomEntityReference 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>QDomEntityReference Class Reference<br><small>[<a href="xml.html">XML module</a>]</small></h1>
33
34<p>The QDomEntityReference class represents an XML entity reference.
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="qdomentityreference-members.html">List of all member functions.</a>
40<h2>Public Members</h2>
41<ul>
42<li class=fn><a href="#QDomEntityReference"><b>QDomEntityReference</b></a> ()</li>
43<li class=fn><a href="#QDomEntityReference-2"><b>QDomEntityReference</b></a> ( const&nbsp;QDomEntityReference&nbsp;&amp;&nbsp;x )</li>
44<li class=fn>QDomEntityReference &amp; <a href="#operator-eq"><b>operator=</b></a> ( const&nbsp;QDomEntityReference&nbsp;&amp;&nbsp;x )</li>
45<li class=fn><a href="#~QDomEntityReference"><b>~QDomEntityReference</b></a> ()</li>
46<li class=fn>virtual QDomNode::NodeType <a href="#nodeType"><b>nodeType</b></a> () const</li>
47<li class=fn>virtual bool <a href="#isEntityReference"><b>isEntityReference</b></a> () const</li>
48</ul>
49<hr><a name="details"></a><h2>Detailed Description</h2>
50
51
52
53The QDomEntityReference class represents an XML entity reference.
54
55<p>
56
57<p> A QDomEntityReference object may be inserted into the DOM tree
58when an entity reference is in the source document, or when the
59user wishes to insert an entity reference.
60<p> Note that character references and references to predefined
61entities are expanded by the XML processor so that characters are
62represented by their Unicode equivalent rather than by an entity
63reference.
64<p> Moreover, the XML processor may completely expand references to
65entities while building the DOM tree, instead of providing
66QDomEntityReference objects.
67<p> If it does provide such objects, then for a given entity reference
68node, it may be that there is no entity node representing the
69referenced entity; but if such an entity exists, then the child
70list of the entity reference node is the same as that of the
71entity node. As with the entity node, all descendents of the
72entity reference are read-only.
73<p> For further information about the Document Object Model see
74<a href="http://www.w3.org/TR/REC-DOM-Level-1/">http://www.w3.org/TR/REC-DOM-Level-1/</a> and
75<a href="http://www.w3.org/TR/DOM-Level-2-Core/">http://www.w3.org/TR/DOM-Level-2-Core/</a>.
76For a more general introduction of the DOM implementation see the
77<a href="qdomdocument.html">QDomDocument</a> documentation.
78<p>See also <a href="xml-tools.html">XML</a>.
79
80<hr><h2>Member Function Documentation</h2>
81<h3 class=fn><a name="QDomEntityReference"></a>QDomEntityReference::QDomEntityReference ()
82</h3>
83Constructs an empty entity reference. Use
84<a href="qdomdocument.html#createEntityReference">QDomDocument::createEntityReference</a>() to create a entity reference
85with content.
86
87<h3 class=fn><a name="QDomEntityReference-2"></a>QDomEntityReference::QDomEntityReference ( const&nbsp;<a href="qdomentityreference.html">QDomEntityReference</a>&nbsp;&amp;&nbsp;x )
88</h3>
89Constructs a copy of <em>x</em>.
90<p> The data of the copy is shared (shallow copy): modifying one node
91will also change the other. If you want to make a <a href="shclass.html#deep-copy">deep copy</a>, use
92<a href="qdomnode.html#cloneNode">cloneNode</a>().
93
94<h3 class=fn><a name="~QDomEntityReference"></a>QDomEntityReference::~QDomEntityReference ()
95</h3>
96Destroys the object and frees its resources.
97
98<h3 class=fn>bool <a name="isEntityReference"></a>QDomEntityReference::isEntityReference () const<tt> [virtual]</tt>
99</h3>
100Returns TRUE.
101
102<p>Reimplemented from <a href="qdomnode.html#isEntityReference">QDomNode</a>.
103<h3 class=fn><a href="qdomnode.html#NodeType-enum">QDomNode::NodeType</a> <a name="nodeType"></a>QDomEntityReference::nodeType () const<tt> [virtual]</tt>
104</h3>
105Returns <tt>EntityReference</tt>.
106
107<p>Reimplemented from <a href="qdomnode.html#nodeType">QDomNode</a>.
108<h3 class=fn><a href="qdomentityreference.html">QDomEntityReference</a>&nbsp;&amp; <a name="operator-eq"></a>QDomEntityReference::operator= ( const&nbsp;<a href="qdomentityreference.html">QDomEntityReference</a>&nbsp;&amp;&nbsp;x )
109</h3>
110Assigns <em>x</em> to this entity reference.
111<p> The data of the copy is shared (shallow copy): modifying one node
112will also change the other. If you want to make a <a href="shclass.html#deep-copy">deep copy</a>, use
113<a href="qdomnode.html#cloneNode">cloneNode</a>().
114
115<!-- eof -->
116<hr><p>
117This file is part of the <a href="index.html">Qt toolkit</a>.
118Copyright &copy; 1995-2007
119<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
120<table width=100% cellspacing=0 border=0><tr>
121<td>Copyright &copy; 2007
122<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
123<td align=right><div align=right>Qt 3.3.8</div>
124</table></div></address></body>
125</html>
Note: See TracBrowser for help on using the repository browser.