source: trunk/doc/html/qdomcomment.html@ 203

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

reference documentation added
File size: 5.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:4820 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>QDomComment 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>QDomComment Class Reference<br><small>[<a href="xml.html">XML module</a>]</small></h1>
33
34<p>The QDomComment class represents an XML comment.
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="qdomcharacterdata.html">QDomCharacterData</a>.
39<p><a href="qdomcomment-members.html">List of all member functions.</a>
40<h2>Public Members</h2>
41<ul>
42<li class=fn><a href="#QDomComment"><b>QDomComment</b></a> ()</li>
43<li class=fn><a href="#QDomComment-2"><b>QDomComment</b></a> ( const&nbsp;QDomComment&nbsp;&amp;&nbsp;x )</li>
44<li class=fn>QDomComment &amp; <a href="#operator-eq"><b>operator=</b></a> ( const&nbsp;QDomComment&nbsp;&amp;&nbsp;x )</li>
45<li class=fn><a href="#~QDomComment"><b>~QDomComment</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="#isComment"><b>isComment</b></a> () const</li>
48</ul>
49<hr><a name="details"></a><h2>Detailed Description</h2>
50
51
52
53The QDomComment class represents an XML comment.
54
55<p>
56
57<p> A comment in the parsed XML such as this:
58<pre>
59 &lt;!-- this is a comment --&gt;
60 </pre>
61
62is represented by QDomComment objects in the parsed Dom tree.
63<p> For further information about the Document Object Model see
64<a href="http://www.w3.org/TR/REC-DOM-Level-1/">http://www.w3.org/TR/REC-DOM-Level-1/</a> and
65<a href="http://www.w3.org/TR/DOM-Level-2-Core/">http://www.w3.org/TR/DOM-Level-2-Core/</a>.
66For a more general introduction of the DOM implementation see the
67<a href="qdomdocument.html">QDomDocument</a> documentation.
68<p>See also <a href="xml-tools.html">XML</a>.
69
70<hr><h2>Member Function Documentation</h2>
71<h3 class=fn><a name="QDomComment"></a>QDomComment::QDomComment ()
72</h3>
73Constructs an empty comment. To construct a comment with content,
74use the <a href="qdomdocument.html#createComment">QDomDocument::createComment</a>() function.
75
76<h3 class=fn><a name="QDomComment-2"></a>QDomComment::QDomComment ( const&nbsp;<a href="qdomcomment.html">QDomComment</a>&nbsp;&amp;&nbsp;x )
77</h3>
78Constructs a copy of <em>x</em>.
79<p> The data of the copy is shared (shallow copy): modifying one node
80will also change the other. If you want to make a <a href="shclass.html#deep-copy">deep copy</a>, use
81<a href="qdomnode.html#cloneNode">cloneNode</a>().
82
83<h3 class=fn><a name="~QDomComment"></a>QDomComment::~QDomComment ()
84</h3>
85Destroys the object and frees its resources.
86
87<h3 class=fn>bool <a name="isComment"></a>QDomComment::isComment () const<tt> [virtual]</tt>
88</h3>
89Returns TRUE.
90
91<p>Reimplemented from <a href="qdomnode.html#isComment">QDomNode</a>.
92<h3 class=fn><a href="qdomnode.html#NodeType-enum">QDomNode::NodeType</a> <a name="nodeType"></a>QDomComment::nodeType () const<tt> [virtual]</tt>
93</h3>
94Returns <a href="qdomnode.html#NodeType-enum">CommentNode</a>.
95
96<p>Reimplemented from <a href="qdomcharacterdata.html#nodeType">QDomCharacterData</a>.
97<h3 class=fn><a href="qdomcomment.html">QDomComment</a>&nbsp;&amp; <a name="operator-eq"></a>QDomComment::operator= ( const&nbsp;<a href="qdomcomment.html">QDomComment</a>&nbsp;&amp;&nbsp;x )
98</h3>
99Assigns <em>x</em> to this DOM comment.
100<p> The data of the copy is shared (shallow copy): modifying one node
101will also change the other. If you want to make a <a href="shclass.html#deep-copy">deep copy</a>, use
102<a href="qdomnode.html#cloneNode">cloneNode</a>().
103
104<!-- eof -->
105<hr><p>
106This file is part of the <a href="index.html">Qt toolkit</a>.
107Copyright &copy; 1995-2007
108<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
109<table width=100% cellspacing=0 border=0><tr>
110<td>Copyright &copy; 2007
111<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
112<td align=right><div align=right>Qt 3.3.8</div>
113</table></div></address></body>
114</html>
Note: See TracBrowser for help on using the repository browser.