blob: 43120b82ec54b1c6418c686d7c829eab4d911e92 [file] [log] [blame]
<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>XalanSourceTreeComment.hpp</h1><a href="XalanSourceTreeComment_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <font class="comment">/*</font>
00002 <font class="comment"> * Copyright 1999-2004 The Apache Software Foundation.</font>
00003 <font class="comment"> *</font>
00004 <font class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</font>
00005 <font class="comment"> * you may not use this file except in compliance with the License.</font>
00006 <font class="comment"> * You may obtain a copy of the License at</font>
00007 <font class="comment"> *</font>
00008 <font class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</font>
00009 <font class="comment"> *</font>
00010 <font class="comment"> * Unless required by applicable law or agreed to in writing, software</font>
00011 <font class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</font>
00012 <font class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</font>
00013 <font class="comment"> * See the License for the specific language governing permissions and</font>
00014 <font class="comment"> * limitations under the License.</font>
00015 <font class="comment"> */</font>
00016 <font class="preprocessor">#if !defined(XALANSOURCETREECOMMENT_HEADER_GUARD_1357924680)</font>
<a name="l00017"></a><a class="code" href="XalanSourceTreeComment_8hpp.html#a0">00017</a> <font class="preprocessor"></font><font class="preprocessor">#define XALANSOURCETREECOMMENT_HEADER_GUARD_1357924680</font>
00018 <font class="preprocessor"></font>
00019
00020
00021 <font class="preprocessor">#include &lt;<a class="code" href="XalanSourceTreeDefinitions_8hpp.html">xalanc/XalanSourceTree/XalanSourceTreeDefinitions.hpp</a>&gt;</font>
00022
00023
00024
00025 <font class="preprocessor">#include &lt;<a class="code" href="XalanComment_8hpp.html">xalanc/XalanDOM/XalanComment.hpp</a>&gt;</font>
00026
00027
00028
00029 <font class="preprocessor">#include &lt;<a class="code" href="XalanDOMString_8hpp.html">xalanc/XalanDOM/XalanDOMString.hpp</a>&gt;</font>
00030
00031
00032
00033 XALAN_CPP_NAMESPACE_BEGIN
00034
00035
00036
<a name="l00037"></a><a class="code" href="XalanSourceTreeComment_8hpp.html#a1">00037</a> <font class="keyword">class </font><a class="code" href="classXalanSourceTreeDocument.html">XalanSourceTreeDocument</a>;
00038 <font class="keyword">class </font><a class="code" href="classXalanSourceTreeDocumentFragment.html">XalanSourceTreeDocumentFragment</a>;
00039 <font class="keyword">class </font><a class="code" href="classXalanSourceTreeElement.html">XalanSourceTreeElement</a>;
00040 <font class="keyword">class </font><a class="code" href="classXalanSourceTreeProcessingInstruction.html">XalanSourceTreeProcessingInstruction</a>;
00041 <font class="keyword">class </font><a class="code" href="classXalanSourceTreeText.html">XalanSourceTreeText</a>;
00042
00043
00044
00045 <font class="comment">/*</font>
00046 <font class="comment"> * &lt;meta name="usage" content="experimental"/&gt;</font>
00047 <font class="comment"> *</font>
00048 <font class="comment"> * Base class for the Xalan source tree Attr interface.</font>
00049 <font class="comment"> *</font>
00050 <font class="comment"> * This class is experimental and subject to change!!</font>
00051 <font class="comment"> */</font>
00052
<a name="l00053"></a><a class="code" href="classXalanSourceTreeComment.html">00053</a> <font class="keyword">class </font>XALAN_XALANSOURCETREE_EXPORT <a class="code" href="classXalanSourceTreeComment.html">XalanSourceTreeComment</a> : <font class="keyword">public</font> <a class="code" href="classXalanComment.html">XalanComment</a>
00054 {
00055 <font class="keyword">public</font>:
00056
00060 <font class="keyword">static</font> <font class="keywordtype">void</font>
00061 <a class="code" href="classXalanSourceTreeComment.html#d0">initialize</a>(MemoryManagerType&amp; theManager);
00062
00066 <font class="keyword">static</font> <font class="keywordtype">void</font>
00067 <a class="code" href="classXalanSourceTreeComment.html#d1">terminate</a>();
00068
00069
00080 <a class="code" href="XalanSourceTreeText_8hpp.html#a1">XalanSourceTreeComment</a>(
00081 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theData,
00082 <a class="code" href="classXalanSourceTreeDocument.html">XalanSourceTreeDocument</a>* theOwnerDocument,
00083 <a class="code" href="classXalanNode.html">XalanNode</a>* theParentNode = 0,
00084 <a class="code" href="classXalanNode.html">XalanNode</a>* thePreviousSibling = 0,
00085 <a class="code" href="classXalanNode.html">XalanNode</a>* theNextSibling = 0,
00086 IndexType theIndex = 0);
00087
00088 <font class="keyword">virtual</font>
00089 <a class="code" href="classXalanSourceTreeComment.html#a1">~XalanSourceTreeComment</a>();
00090
00091
00095 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
00096 <a class="code" href="classXalanComment.html#a2">getNodeName</a>() <font class="keyword">const</font>;
00097
00101 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
00102 <a class="code" href="classXalanComment.html#a3">getNodeValue</a>() <font class="keyword">const</font>;
00103
00107 <font class="keyword">virtual</font> NodeType
00108 <a class="code" href="classXalanComment.html#a4">getNodeType</a>() <font class="keyword">const</font>;
00109
00119 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00120 <a class="code" href="classXalanComment.html#a5">getParentNode</a>() <font class="keyword">const</font>;
00121
00135 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanNodeList.html">XalanNodeList</a>*
00136 <a class="code" href="classXalanComment.html#a6">getChildNodes</a>() <font class="keyword">const</font>;
00137
00143 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00144 <a class="code" href="classXalanComment.html#a7">getFirstChild</a>() <font class="keyword">const</font>;
00145
00151 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00152 <a class="code" href="classXalanComment.html#a8">getLastChild</a>() <font class="keyword">const</font>;
00153
00159 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00160 <a class="code" href="classXalanComment.html#a9">getPreviousSibling</a>() <font class="keyword">const</font>;
00161
00167 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00168 <a class="code" href="classXalanComment.html#a10">getNextSibling</a>() <font class="keyword">const</font>;
00169
00174 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanNamedNodeMap.html">XalanNamedNodeMap</a>*
00175 <a class="code" href="classXalanComment.html#a11">getAttributes</a>() <font class="keyword">const</font>;
00176
00186 <font class="keyword">virtual</font> <a class="code" href="classXalanDocument.html">XalanDocument</a>*
00187 <a class="code" href="classXalanComment.html#a12">getOwnerDocument</a>() <font class="keyword">const</font>;
00188
00190
00192
00211 <font class="preprocessor">#if defined(XALAN_NO_COVARIANT_RETURN_TYPE)</font>
00212 <font class="preprocessor"></font> <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00213 <font class="preprocessor">#else</font>
00214 <font class="preprocessor"></font> <font class="keyword">virtual</font> <a class="code" href="classXalanSourceTreeComment.html">XalanSourceTreeComment</a>*
00215 <font class="preprocessor">#endif</font>
00216 <font class="preprocessor"></font> <a class="code" href="classXalanComment.html#a13">cloneNode</a>(<font class="keywordtype">bool</font> deep) <font class="keyword">const</font>;
00217
00219
00221
00238 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00239 <a class="code" href="classXalanComment.html#a14">insertBefore</a>(
00240 <a class="code" href="classXalanNode.html">XalanNode</a>* newChild,
00241 <a class="code" href="classXalanNode.html">XalanNode</a>* refChild);
00242
00256 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00257 <a class="code" href="classXalanComment.html#a15">replaceChild</a>(
00258 <a class="code" href="classXalanNode.html">XalanNode</a>* newChild,
00259 <a class="code" href="classXalanNode.html">XalanNode</a>* oldChild);
00260
00268 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00269 <a class="code" href="classXalanComment.html#a16">removeChild</a>(<a class="code" href="classXalanNode.html">XalanNode</a>* oldChild);
00270
00282 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00283 <a class="code" href="classXalanComment.html#a17">appendChild</a>(<a class="code" href="classXalanNode.html">XalanNode</a>* newChild);
00284
00286
00288
00296 <font class="keyword">virtual</font> <font class="keywordtype">bool</font>
00297 <a class="code" href="classXalanComment.html#a18">hasChildNodes</a>() <font class="keyword">const</font>;
00298
00299
00301
00303
00317 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00318 <a class="code" href="classXalanComment.html#a19">setNodeValue</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; nodeValue);
00319
00321
00323
00340 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00341 <a class="code" href="classXalanComment.html#a20">normalize</a>();
00342
00356 <font class="keyword">virtual</font> <font class="keywordtype">bool</font>
00357 <a class="code" href="classXalanComment.html#a21">isSupported</a>(
00358 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; feature,
00359 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; version) <font class="keyword">const</font>;
00360
00374 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
00375 <a class="code" href="classXalanComment.html#a22">getNamespaceURI</a>() <font class="keyword">const</font>;
00376
00381 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
00382 <a class="code" href="classXalanComment.html#a23">getPrefix</a>() <font class="keyword">const</font>;
00383
00391 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
00392 <a class="code" href="classXalanComment.html#a24">getLocalName</a>() <font class="keyword">const</font>;
00393
00423 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00424 <a class="code" href="classXalanComment.html#a25">setPrefix</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; prefix);
00425
00426 <font class="keyword">virtual</font> <font class="keywordtype">bool</font>
00427 <a class="code" href="classXalanComment.html#a26">isIndexed</a>() <font class="keyword">const</font>;
00428
00429 <font class="keyword">virtual</font> IndexType
00430 <a class="code" href="classXalanComment.html#a27">getIndex</a>() <font class="keyword">const</font>;
00431
00433
00434 <font class="comment">// These interfaces are inherited from XalanCDATASection...</font>
00435
00438
00454 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
00455 <a class="code" href="classXalanComment.html#a28">getData</a>() <font class="keyword">const</font>;
00456
00464 <font class="keyword">virtual</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font>
00465 <a class="code" href="classXalanComment.html#a29">getLength</a>() <font class="keyword">const</font>;
00466
00482 <font class="keyword">virtual</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
00483 <a class="code" href="classXalanComment.html#a30">substringData</a>(
00484 <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> offset,
00485 <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> count,
00486 <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theBuffer) <font class="keyword">const</font>;
00487
00489
00491
00500 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00501 <a class="code" href="classXalanComment.html#a31">appendData</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; arg);
00502
00513 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00514 <a class="code" href="classXalanComment.html#a32">insertData</a>(
00515 <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> offset,
00516 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; arg);
00517
00534 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00535 <a class="code" href="classXalanComment.html#a33">deleteData</a>(
00536 <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> offset,
00537 <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> count);
00538
00557 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00558 <a class="code" href="classXalanComment.html#a34">replaceData</a>(
00559 <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> offset,
00560 <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> count,
00561 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; arg);
00562
00564
00565
00566 <font class="comment">// public interfaces not inherited from XalanComment...</font>
00567
00568 <font class="keywordtype">void</font>
00569 <a class="code" href="classXalanSourceTreeComment.html#a35">setParent</a>(<a class="code" href="classXalanSourceTreeElement.html">XalanSourceTreeElement</a>* theParent);
00570
00571 <font class="keywordtype">void</font>
00572 <a class="code" href="classXalanSourceTreeComment.html#a35">setParent</a>(<a class="code" href="classXalanSourceTreeDocumentFragment.html">XalanSourceTreeDocumentFragment</a>* theParent);
00573
00574 <font class="keywordtype">void</font>
00575 <a class="code" href="classXalanSourceTreeComment.html#a37">setPreviousSibling</a>(<a class="code" href="classXalanSourceTreeComment.html">XalanSourceTreeComment</a>* thePreviousSibling);
00576
00577 <font class="keywordtype">void</font>
00578 <a class="code" href="classXalanSourceTreeComment.html#a37">setPreviousSibling</a>(<a class="code" href="classXalanSourceTreeElement.html">XalanSourceTreeElement</a>* thePreviousSibling);
00579
00580 <font class="keywordtype">void</font>
00581 <a class="code" href="classXalanSourceTreeComment.html#a37">setPreviousSibling</a>(<a class="code" href="classXalanSourceTreeProcessingInstruction.html">XalanSourceTreeProcessingInstruction</a>* thePreviousSibling);
00582
00583 <font class="keywordtype">void</font>
00584 <a class="code" href="classXalanSourceTreeComment.html#a37">setPreviousSibling</a>(<a class="code" href="classXalanSourceTreeText.html">XalanSourceTreeText</a>* thePreviousSibling);
00585
00586 <font class="keywordtype">void</font>
00587 <a class="code" href="classXalanSourceTreeComment.html#a41">appendSiblingNode</a>(<a class="code" href="classXalanSourceTreeComment.html">XalanSourceTreeComment</a>* theSibling);
00588
00589 <font class="keywordtype">void</font>
00590 <a class="code" href="classXalanSourceTreeComment.html#a41">appendSiblingNode</a>(<a class="code" href="classXalanSourceTreeElement.html">XalanSourceTreeElement</a>* theSibling);
00591
00592 <font class="keywordtype">void</font>
00593 <a class="code" href="classXalanSourceTreeComment.html#a41">appendSiblingNode</a>(<a class="code" href="classXalanSourceTreeProcessingInstruction.html">XalanSourceTreeProcessingInstruction</a>* theSibling);
00594
00595 <font class="keywordtype">void</font>
00596 <a class="code" href="classXalanSourceTreeComment.html#a41">appendSiblingNode</a>(<a class="code" href="classXalanSourceTreeText.html">XalanSourceTreeText</a>* theSibling);
00597
00598 <font class="keywordtype">void</font>
<a name="l00599"></a><a class="code" href="classXalanSourceTreeComment.html#a45">00599</a> <a class="code" href="classXalanSourceTreeComment.html#a45">setIndex</a>(IndexType theIndex)<font class="keyword"></font>
00600 <font class="keyword"> </font>{
00601 m_index = theIndex;
00602 }
00603
00604 <font class="keyword">protected</font>:
00605
00606 <a class="code" href="XalanSourceTreeText_8hpp.html#a1">XalanSourceTreeComment</a>(
00607 <font class="keyword">const</font> <a class="code" href="classXalanSourceTreeComment.html">XalanSourceTreeComment</a>&amp; theSource,
00608 <font class="keywordtype">bool</font> deep = <font class="keyword">false</font>);
00609
00610 <font class="keyword">private</font>:
00611
00612 <font class="comment">// Not implemented...</font>
00613 <a class="code" href="classXalanSourceTreeComment.html">XalanSourceTreeComment</a>&amp;
00614 <a class="code" href="classXalanComment.html#b1">operator=</a>(<font class="keyword">const</font> <a class="code" href="classXalanSourceTreeComment.html">XalanSourceTreeComment</a>&amp; theSource);
00615
00616 <font class="keywordtype">bool</font>
00617 <a class="code" href="classXalanComment.html#b2">operator==</a>(<font class="keyword">const</font> <a class="code" href="classXalanSourceTreeComment.html">XalanSourceTreeComment</a>&amp; theRHS) <font class="keyword">const</font>;
00618
00619
00620 <font class="comment">// Data members...</font>
00621 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; m_data;
00622
00623 <a class="code" href="classXalanSourceTreeDocument.html">XalanSourceTreeDocument</a>* m_ownerDocument;
00624
00625 <a class="code" href="classXalanNode.html">XalanNode</a>* m_parentNode;
00626
00627 <a class="code" href="classXalanNode.html">XalanNode</a>* m_previousSibling;
00628
00629 <a class="code" href="classXalanNode.html">XalanNode</a>* m_nextSibling;
00630
00631 IndexType m_index;
00632
00633 <font class="keyword">static</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; s_nameString;
00634 };
00635
00636
00637
00638 XALAN_CPP_NAMESPACE_END
00639
00640
00641
00642 <font class="preprocessor">#endif // !defined(XALANSOURCETREECOMMENT_HEADER_GUARD_1357924680)</font>
</font></pre></div><p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and
<A href="http://www.research.att.com/sw/tools/graphviz/">GraphViz</A> are used to generate this API documentation from the Xalan-C header files.</I></FONT></p>
<TABLE border="0" cellpadding="0" cellspacing="0" width="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="80%">
<TR>
<TD WIDTH="80%" VALIGN="TOP">
<P ALIGN="CENTER"><B>Xalan-C++ XSLT Processor Version 1.10</B><BR>
Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
</TD>
</TR>
<TR>
<TD WIDTH="100%">
<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
</TD>
</TR>
</TABLE>