Google Git
Sign in
apache / xalan-site / 4279effacee2ebacf30f00b46c22db2aacb59b72 / . / old / xalan-c / apiDocs / XalanDocument_8hpp-source.html
blob: 9b7902d52b5891b7c3e56fb46e85303c861ec6ae [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>XalanDocument.hpp</h1><a href="XalanDocument_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(XALANDOCUMENT_HEADER_GUARD_1357924680)</font>
<a name="l00017"></a><a class="code" href="XalanDocument_8hpp.html#a0">00017</a> <font class="preprocessor"></font><font class="preprocessor">#define XALANDOCUMENT_HEADER_GUARD_1357924680</font>
00018 <font class="preprocessor"></font>
00019
00020
00021 <font class="preprocessor">#include &lt;<a class="code" href="XalanDOMDefinitions_8hpp.html">xalanc/XalanDOM/XalanDOMDefinitions.hpp</a>&gt;</font>
00022 <font class="preprocessor">#include &lt;<a class="code" href="XalanNode_8hpp.html">xalanc/XalanDOM/XalanNode.hpp</a>&gt;</font>
00023
00024
00025
00026 XALAN_CPP_NAMESPACE_BEGIN
00027
00028
00029
<a name="l00030"></a><a class="code" href="XalanDocument_8hpp.html#a1">00030</a> <font class="keyword">class </font><a class="code" href="classXalanAttr.html">XalanAttr</a>;
00031 <font class="keyword">class </font><a class="code" href="classXalanCDATASection.html">XalanCDATASection</a>;
00032 <font class="keyword">class </font><a class="code" href="classXalanComment.html">XalanComment</a>;
00033 <font class="keyword">class </font><a class="code" href="classXalanDocumentFragment.html">XalanDocumentFragment</a>;
00034 <font class="keyword">class </font><a class="code" href="classXalanDocumentType.html">XalanDocumentType</a>;
00035 <font class="keyword">class </font><a class="code" href="classXalanDOMImplementation.html">XalanDOMImplementation</a>;
00036 <font class="keyword">class </font><a class="code" href="classXalanElement.html">XalanElement</a>;
00037 <font class="keyword">class </font><a class="code" href="classXalanEntityReference.html">XalanEntityReference</a>;
00038 <font class="keyword">class </font><a class="code" href="classXalanProcessingInstruction.html">XalanProcessingInstruction</a>;
00039 <font class="keyword">class </font><a class="code" href="classXalanText.html">XalanText</a>;
00040
00041
00042
00043 <font class="comment">/*</font>
00044 <font class="comment"> * &lt;meta name="usage" content="experimental"/&gt;</font>
00045 <font class="comment"> *</font>
00046 <font class="comment"> * Base class for the DOM Document interface.</font>
00047 <font class="comment"> *</font>
00048 <font class="comment"> * This class is experimental and subject to change!!</font>
00049 <font class="comment"> */</font>
00050
<a name="l00051"></a><a class="code" href="classXalanDocument.html">00051</a> <font class="keyword">class </font>XALAN_DOM_EXPORT <a class="code" href="classXalanDocument.html">XalanDocument</a> : <font class="keyword">public</font> <a class="code" href="classXalanNode.html">XalanNode</a>
00052 {
00053 <font class="keyword">public</font>:
00054
00055 <a class="code" href="FormatterToDOM_8hpp.html#a1">XalanDocument</a>();
00056
00057 <font class="keyword">virtual</font>
00058 <a class="code" href="classXalanDocument.html#a1">~XalanDocument</a>();
00059
00060 <font class="comment">// These interfaces are inherited from XalanNode...</font>
00061
00062 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
00063 <a class="code" href="classXalanNode.html#a2">getNodeName</a>() <font class="keyword">const</font> = 0;
00064
00068 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
00069 <a class="code" href="classXalanNode.html#a3">getNodeValue</a>() <font class="keyword">const</font> = 0;
00070
00074 <font class="keyword">virtual</font> NodeType
00075 <a class="code" href="classXalanNode.html#a4">getNodeType</a>() <font class="keyword">const</font> = 0;
00076
00086 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00087 <a class="code" href="classXalanNode.html#a5">getParentNode</a>() <font class="keyword">const</font> = 0;
00088
00102 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanNodeList.html">XalanNodeList</a>*
00103 <a class="code" href="classXalanNode.html#a6">getChildNodes</a>() <font class="keyword">const</font> = 0;
00104
00110 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00111 <a class="code" href="classXalanNode.html#a7">getFirstChild</a>() <font class="keyword">const</font> = 0;
00112
00118 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00119 <a class="code" href="classXalanNode.html#a8">getLastChild</a>() <font class="keyword">const</font> = 0;
00120
00126 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00127 <a class="code" href="classXalanNode.html#a9">getPreviousSibling</a>() <font class="keyword">const</font> = 0;
00128
00134 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00135 <a class="code" href="classXalanNode.html#a10">getNextSibling</a>() <font class="keyword">const</font> = 0;
00136
00141 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanNamedNodeMap.html">XalanNamedNodeMap</a>*
00142 <a class="code" href="classXalanNode.html#a11">getAttributes</a>() <font class="keyword">const</font> = 0;
00143
00153 <font class="keyword">virtual</font> <a class="code" href="classXalanDocument.html">XalanDocument</a>*
00154 <a class="code" href="classXalanNode.html#a12">getOwnerDocument</a>() <font class="keyword">const</font> = 0;
00155
00157
00159
00178 <font class="preprocessor">#if defined(XALAN_NO_COVARIANT_RETURN_TYPE)</font>
00179 <font class="preprocessor"></font> <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00180 <font class="preprocessor">#else</font>
00181 <font class="preprocessor"></font> <font class="keyword">virtual</font> <a class="code" href="classXalanDocument.html">XalanDocument</a>*
00182 <font class="preprocessor">#endif</font>
00183 <font class="preprocessor"></font> <a class="code" href="classXalanNode.html#a13">cloneNode</a>(<font class="keywordtype">bool</font> deep) <font class="keyword">const</font> = 0;
00184
00186
00188
00205 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00206 <a class="code" href="classXalanNode.html#a14">insertBefore</a>(
00207 <a class="code" href="classXalanNode.html">XalanNode</a>* newChild,
00208 <a class="code" href="classXalanNode.html">XalanNode</a>* refChild) = 0;
00209
00223 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00224 <a class="code" href="classXalanNode.html#a15">replaceChild</a>(
00225 <a class="code" href="classXalanNode.html">XalanNode</a>* newChild,
00226 <a class="code" href="classXalanNode.html">XalanNode</a>* oldChild) = 0;
00227
00235 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00236 <a class="code" href="classXalanNode.html#a16">removeChild</a>(<a class="code" href="classXalanNode.html">XalanNode</a>* oldChild) = 0;
00237
00249 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00250 <a class="code" href="classXalanNode.html#a17">appendChild</a>(<a class="code" href="classXalanNode.html">XalanNode</a>* newChild) = 0;
00251
00253
00255
00263 <font class="keyword">virtual</font> <font class="keywordtype">bool</font>
00264 <a class="code" href="classXalanNode.html#a18">hasChildNodes</a>() <font class="keyword">const</font> = 0;
00265
00266
00268
00270
00271
00285 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00286 <a class="code" href="classXalanNode.html#a19">setNodeValue</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; nodeValue) = 0;
00287
00289
00291
00308 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00309 <a class="code" href="classXalanNode.html#a20">normalize</a>() = 0;
00310
00324 <font class="keyword">virtual</font> <font class="keywordtype">bool</font>
00325 <a class="code" href="classXalanNode.html#a21">isSupported</a>(
00326 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; feature,
00327 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; version) <font class="keyword">const</font> = 0;
00328
00342 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
00343 <a class="code" href="classXalanNode.html#a22">getNamespaceURI</a>() <font class="keyword">const</font> = 0;
00344
00349 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
00350 <a class="code" href="classXalanNode.html#a23">getPrefix</a>() <font class="keyword">const</font> = 0;
00351
00359 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
00360 <a class="code" href="classXalanNode.html#a24">getLocalName</a>() <font class="keyword">const</font> = 0;
00361
00391 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00392 <a class="code" href="classXalanNode.html#a25">setPrefix</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; prefix) = 0;
00393
00399 <font class="keyword">virtual</font> <font class="keywordtype">bool</font>
00400 <a class="code" href="classXalanNode.html#a26">isIndexed</a>() <font class="keyword">const</font> = 0;
00401
00408 <font class="keyword">virtual</font> IndexType
00409 <a class="code" href="classXalanNode.html#a27">getIndex</a>() <font class="keyword">const</font> = 0;
00410
00412
00413 <font class="comment">// These interfaces are new to XalanDocument...</font>
00414
00424 <font class="keyword">virtual</font> <a class="code" href="classXalanElement.html">XalanElement</a>*
00425 <a class="code" href="classXalanDocument.html#a28">createElement</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; tagName) = 0;
00426
00433 <font class="keyword">virtual</font> <a class="code" href="classXalanDocumentFragment.html">XalanDocumentFragment</a>*
00434 <a class="code" href="classXalanDocument.html#a29">createDocumentFragment</a>() = 0;
00435
00443 <font class="keyword">virtual</font> <a class="code" href="classXalanText.html">XalanText</a>*
00444 <a class="code" href="classXalanDocument.html#a30">createTextNode</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; data) = 0;
00445
00453 <font class="keyword">virtual</font> <a class="code" href="classXalanComment.html">XalanComment</a>*
00454 <a class="code" href="classXalanDocument.html#a31">createComment</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; data) = 0;
00455
00465 <font class="keyword">virtual</font> <a class="code" href="classXalanCDATASection.html">XalanCDATASection</a>*
00466 <a class="code" href="classXalanDocument.html#a32">createCDATASection</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; data) = 0;
00467
00479 <font class="keyword">virtual</font> <a class="code" href="classXalanProcessingInstruction.html">XalanProcessingInstruction</a>*
00480 <a class="code" href="classXalanDocument.html#a33">createProcessingInstruction</a>(
00481 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; target,
00482 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; data) = 0;
00483
00500 <font class="keyword">virtual</font> <a class="code" href="classXalanAttr.html">XalanAttr</a>*
00501 <a class="code" href="classXalanDocument.html#a34">createAttribute</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; name) = 0;
00502
00513 <font class="keyword">virtual</font> <a class="code" href="classXalanEntityReference.html">XalanEntityReference</a>*
00514 <a class="code" href="classXalanDocument.html#a35">createEntityReference</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a> &amp;name) = 0;
00515
00517
00519
00528 <font class="keyword">virtual</font> <a class="code" href="classXalanDocumentType.html">XalanDocumentType</a>*
00529 <a class="code" href="classXalanDocument.html#a36">getDoctype</a>() <font class="keyword">const</font> = 0;
00530
00531
00535 <font class="keyword">virtual</font> <a class="code" href="classXalanDOMImplementation.html">XalanDOMImplementation</a>*
00536 <a class="code" href="classXalanDocument.html#a37">getImplementation</a>() <font class="keyword">const</font> = 0;
00537
00538
00542 <font class="keyword">virtual</font> <a class="code" href="classXalanElement.html">XalanElement</a>*
00543 <a class="code" href="classXalanDocument.html#a38">getDocumentElement</a>() <font class="keyword">const</font> = 0;
00544
00559 <font class="keyword">virtual</font> <a class="code" href="classXalanNodeList.html">XalanNodeList</a>*
00560 <a class="code" href="classXalanDocument.html#a39">getElementsByTagName</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; tagname) <font class="keyword">const</font> = 0;
00561
00563
00565
00588 <font class="keyword">virtual</font> <a class="code" href="classXalanNode.html">XalanNode</a>*
00589 <a class="code" href="classXalanDocument.html#a40">importNode</a>(
00590 <a class="code" href="classXalanNode.html">XalanNode</a>* importedNode,
00591 <font class="keywordtype">bool</font> deep) = 0;
00592
00615 <font class="keyword">virtual</font> <a class="code" href="classXalanElement.html">XalanElement</a>*
00616 <a class="code" href="classXalanDocument.html#a41">createElementNS</a>(
00617 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; namespaceURI,
00618 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; qualifiedName) = 0;
00619
00648 <font class="keyword">virtual</font> <a class="code" href="classXalanAttr.html">XalanAttr</a>*
00649 <a class="code" href="classXalanDocument.html#a42">createAttributeNS</a>(
00650 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; namespaceURI,
00651 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; qualifiedName) = 0;
00652
00669 <font class="keyword">virtual</font> <a class="code" href="classXalanNodeList.html">XalanNodeList</a>*
00670 <a class="code" href="classXalanDocument.html#a43">getElementsByTagNameNS</a>(
00671 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; namespaceURI,
00672 <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; localName) <font class="keyword">const</font> = 0;
00673
00689 <font class="keyword">virtual</font> <a class="code" href="classXalanElement.html">XalanElement</a>*
00690 <a class="code" href="classXalanDocument.html#a44">getElementById</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; elementId) <font class="keyword">const</font> = 0;
00691
00693
00694 <font class="keyword">protected</font>:
00695
00696 <a class="code" href="FormatterToDOM_8hpp.html#a1">XalanDocument</a>(<font class="keyword">const</font> <a class="code" href="classXalanDocument.html">XalanDocument</a>&amp; theSource);
00697
00698 <a class="code" href="classXalanDocument.html">XalanDocument</a>&amp;
00699 <a class="code" href="classXalanNode.html#b1">operator=</a>(<font class="keyword">const</font> <a class="code" href="classXalanDocument.html">XalanDocument</a>&amp; theSource);
00700
00701 <font class="keywordtype">bool</font>
00702 <a class="code" href="classXalanNode.html#b2">operator==</a>(<font class="keyword">const</font> <a class="code" href="classXalanDocument.html">XalanDocument</a>&amp; theRHS) <font class="keyword">const</font>;
00703
00704 <font class="keyword">private</font>:
00705 };
00706
00707
00708
00709 XALAN_CPP_NAMESPACE_END
00710
00711
00712
00713 <font class="preprocessor">#endif // !defined(XALANDOCUMENT_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>