<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.4</h3>
</BODY>
<!-- Generated by Doxygen 1.1.2 on Mon Sep 16 08:27:14 2002 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
<hr><h1>XalanSourceTreeComment.hpp</h1><a href="XalanSourceTreeComment.hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 /*
00002 * The Apache Software License, Version 1.1
00003 *
00004 *
00005 * Copyright (c) 1999-2000 The Apache Software Foundation. All rights
00006 * reserved.
00007 *
00008 * Redistribution and use in source and binary forms, with or without
00009 * modification, are permitted provided that the following conditions
00010 * are met:
00011 *
00012 * 1. Redistributions of source code must retain the above copyright
00013 * notice, this list of conditions and the following disclaimer.
00014 *
00015 * 2. Redistributions in binary form must reproduce the above copyright
00016 * notice, this list of conditions and the following disclaimer in
00017 * the documentation and/or other materials provided with the
00018 * distribution.
00019 *
00020 * 3. The end-user documentation included with the redistribution,
00021 * if any, must include the following acknowledgment:
00022 * "This product includes software developed by the
00023 * Apache Software Foundation (http://www.apache.org/)."
00024 * Alternately, this acknowledgment may appear in the software itself,
00025 * if and wherever such third-party acknowledgments normally appear.
00026 *
00027 * 4. The names "Xalan" and "Apache Software Foundation" must
00028 * not be used to endorse or promote products derived from this
00029 * software without prior written permission. For written
00030 * permission, please contact apache@apache.org.
00031 *
00032 * 5. Products derived from this software may not be called "Apache",
00033 * nor may "Apache" appear in their name, without prior written
00034 * permission of the Apache Software Foundation.
00035 *
00036 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047 * SUCH DAMAGE.
00048 * ====================================================================
00049 *
00050 * This software consists of voluntary contributions made by many
00051 * individuals on behalf of the Apache Software Foundation and was
00052 * originally based on software copyright (c) 1999, International
00053 * Business Machines, Inc., http://www.ibm.com. For more
00054 * information on the Apache Software Foundation, please see
00055 * <http://www.apache.org/>.
00056 */
00057 #if !defined(XALANSOURCETREECOMMENT_HEADER_GUARD_1357924680)
<a name="l00058"><a class="code" href="XalanSourceTreeComment.hpp.html#a0">00058</a></a> #define XALANSOURCETREECOMMENT_HEADER_GUARD_1357924680
00059
00060
00061
00062 #include <XalanSourceTree/XalanSourceTreeDefinitions.hpp>
00063
00064
00065
00066 #include <XalanDOM/XalanComment.hpp>
00067
00068
00069
00070 #include <XalanDOM/XalanDOMString.hpp>
00071
00072
00073
00074 class <a class="code" href="class_xalansourcetreedocument.html">XalanSourceTreeDocument</a>;
00075 class <a class="code" href="class_xalansourcetreedocumentfragment.html">XalanSourceTreeDocumentFragment</a>;
00076 class <a class="code" href="class_xalansourcetreeelement.html">XalanSourceTreeElement</a>;
00077 class <a class="code" href="class_xalansourcetreeprocessinginstruction.html">XalanSourceTreeProcessingInstruction</a>;
00078 class <a class="code" href="class_xalansourcetreetext.html">XalanSourceTreeText</a>;
00079
00080
00081
00082 /*
00083 * <meta name="usage" content="experimental"/>
00084 *
00085 * Base class for the Xalan source tree Attr interface.
00086 *
00087 * This class is experimental and subject to change!!
00088 */
00089
<a name="l00090"><a class="code" href="class_xalansourcetreecomment.html">00090</a></a> class XALAN_XALANSOURCETREE_EXPORT <a class="code" href="class_xalansourcetreecomment.html">XalanSourceTreeComment</a> : public <a class="code" href="class_xalancomment.html">XalanComment</a>
00091 {
00092 public:
00093
00097 static void
00098 <a class="code" href="class_xalansourcetreecomment.html#d0">initialize</a>();
00099
00103 static void
00104 <a class="code" href="class_xalansourcetreecomment.html#d1">terminate</a>();
00105
00106
00117 <a class="code" href="class_xalansourcetreecomment.html#a0">XalanSourceTreeComment</a>(
00118 const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>& theData,
00119 <a class="code" href="class_xalansourcetreedocument.html">XalanSourceTreeDocument</a>* theOwnerDocument,
00120 <a class="code" href="class_xalannode.html">XalanNode</a>* theParentNode = 0,
00121 <a class="code" href="class_xalannode.html">XalanNode</a>* thePreviousSibling = 0,
00122 <a class="code" href="class_xalannode.html">XalanNode</a>* theNextSibling = 0,
00123 unsigned int theIndex = 0);
00124
00125 virtual
00126 <a class="code" href="class_xalansourcetreecomment.html#a1">~XalanSourceTreeComment</a>();
00127
00128
00132 virtual const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>&
00133 <a class="code" href="class_xalancomment.html#a2">getNodeName</a>() const;
00134
00138 virtual const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>&
00139 <a class="code" href="class_xalancomment.html#a3">getNodeValue</a>() const;
00140
00144 virtual NodeType
00145 <a class="code" href="class_xalancomment.html#a4">getNodeType</a>() const;
00146
00156 virtual <a class="code" href="class_xalannode.html">XalanNode</a>*
00157 <a class="code" href="class_xalancomment.html#a5">getParentNode</a>() const;
00158
00172 virtual const <a class="code" href="class_xalannodelist.html">XalanNodeList</a>*
00173 <a class="code" href="class_xalancomment.html#a6">getChildNodes</a>() const;
00174
00180 virtual <a class="code" href="class_xalannode.html">XalanNode</a>*
00181 <a class="code" href="class_xalancomment.html#a7">getFirstChild</a>() const;
00182
00188 virtual <a class="code" href="class_xalannode.html">XalanNode</a>*
00189 <a class="code" href="class_xalancomment.html#a8">getLastChild</a>() const;
00190
00196 virtual <a class="code" href="class_xalannode.html">XalanNode</a>*
00197 <a class="code" href="class_xalancomment.html#a9">getPreviousSibling</a>() const;
00198
00204 virtual <a class="code" href="class_xalannode.html">XalanNode</a>*
00205 <a class="code" href="class_xalancomment.html#a10">getNextSibling</a>() const;
00206
00211 virtual const <a class="code" href="class_xalannamednodemap.html">XalanNamedNodeMap</a>*
00212 <a class="code" href="class_xalancomment.html#a11">getAttributes</a>() const;
00213
00223 virtual <a class="code" href="class_xalandocument.html">XalanDocument</a>*
00224 <a class="code" href="class_xalancomment.html#a12">getOwnerDocument</a>() const;
00225
00226 //@}
00228 //@{
00229
00248 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00249 virtual <a class="code" href="class_xalannode.html">XalanNode</a>*
00250 #else
00251 virtual <a class="code" href="class_xalansourcetreecomment.html">XalanSourceTreeComment</a>*
00252 #endif
00253 <a class="code" href="class_xalancomment.html#a13">cloneNode</a>(bool deep) const;
00254
00255 //@}
00257 //@{
00258
00275 virtual <a class="code" href="class_xalannode.html">XalanNode</a>*
00276 <a class="code" href="class_xalancomment.html#a14">insertBefore</a>(
00277 <a class="code" href="class_xalannode.html">XalanNode</a>* newChild,
00278 <a class="code" href="class_xalannode.html">XalanNode</a>* refChild);
00279
00293 virtual <a class="code" href="class_xalannode.html">XalanNode</a>*
00294 <a class="code" href="class_xalancomment.html#a15">replaceChild</a>(
00295 <a class="code" href="class_xalannode.html">XalanNode</a>* newChild,
00296 <a class="code" href="class_xalannode.html">XalanNode</a>* oldChild);
00297
00305 virtual <a class="code" href="class_xalannode.html">XalanNode</a>*
00306 <a class="code" href="class_xalancomment.html#a16">removeChild</a>(<a class="code" href="class_xalannode.html">XalanNode</a>* oldChild);
00307
00319 virtual <a class="code" href="class_xalannode.html">XalanNode</a>*
00320 <a class="code" href="class_xalancomment.html#a17">appendChild</a>(<a class="code" href="class_xalannode.html">XalanNode</a>* newChild);
00321
00322 //@}
00324 //@{
00325
00333 virtual bool
00334 <a class="code" href="class_xalancomment.html#a18">hasChildNodes</a>() const;
00335
00336
00337 //@}
00339 //@{
00340
00354 virtual void
00355 <a class="code" href="class_xalancomment.html#a19">setNodeValue</a>(const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>& nodeValue);
00356
00357 //@}
00359 //@{
00360
00377 virtual void
00378 <a class="code" href="class_xalancomment.html#a20">normalize</a>();
00379
00393 virtual bool
00394 <a class="code" href="class_xalancomment.html#a21">isSupported</a>(
00395 const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>& feature,
00396 const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>& version) const;
00397
00411 virtual const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>&
00412 <a class="code" href="class_xalancomment.html#a22">getNamespaceURI</a>() const;
00413
00418 virtual const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>&
00419 <a class="code" href="class_xalancomment.html#a23">getPrefix</a>() const;
00420
00428 virtual const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>&
00429 <a class="code" href="class_xalancomment.html#a24">getLocalName</a>() const;
00430
00460 virtual void
00461 <a class="code" href="class_xalancomment.html#a25">setPrefix</a>(const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>& prefix);
00462
00463 virtual bool
00464 <a class="code" href="class_xalancomment.html#a26">isIndexed</a>() const;
00465
00466 virtual unsigned long
00467 <a class="code" href="class_xalancomment.html#a27">getIndex</a>() const;
00468
00469 //@}
00470
00471 // These interfaces are inherited from XalanCDATASection...
00472
00474 //@{
00491 virtual const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>&
00492 <a class="code" href="class_xalancomment.html#a28">getData</a>() const;
00493
00501 virtual unsigned int
00502 <a class="code" href="class_xalancomment.html#a29">getLength</a>() const;
00503
00519 virtual <a class="code" href="class_xalandomstring.html">XalanDOMString</a>
00520 <a class="code" href="class_xalancomment.html#a30">substringData</a>(
00521 unsigned int offset,
00522 unsigned int count) const;
00523
00524 //@}
00526 //@{
00536 virtual void
00537 <a class="code" href="class_xalancomment.html#a31">appendData</a>(const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>& arg);
00538
00549 virtual void
00550 <a class="code" href="class_xalancomment.html#a32">insertData</a>(
00551 unsigned int offset,
00552 const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>& arg);
00553
00570 virtual void
00571 <a class="code" href="class_xalancomment.html#a33">deleteData</a>(
00572 unsigned int offset,
00573 unsigned int count);
00574
00593 virtual void
00594 <a class="code" href="class_xalancomment.html#a34">replaceData</a>(
00595 unsigned int offset,
00596 unsigned int count,
00597 const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>& arg);
00598
00599 //@}
00600
00601
00602 // public interfaces not inherited from XalanComment...
00603
00604 void
00605 <a class="code" href="class_xalansourcetreecomment.html#a35">setParent</a>(<a class="code" href="class_xalansourcetreeelement.html">XalanSourceTreeElement</a>* theParent);
00606
00607 void
00608 <a class="code" href="class_xalansourcetreecomment.html#a35">setParent</a>(<a class="code" href="class_xalansourcetreedocumentfragment.html">XalanSourceTreeDocumentFragment</a>* theParent);
00609
00610 void
00611 <a class="code" href="class_xalansourcetreecomment.html#a37">setPreviousSibling</a>(<a class="code" href="class_xalansourcetreecomment.html">XalanSourceTreeComment</a>* thePreviousSibling);
00612
00613 void
00614 <a class="code" href="class_xalansourcetreecomment.html#a37">setPreviousSibling</a>(<a class="code" href="class_xalansourcetreeelement.html">XalanSourceTreeElement</a>* thePreviousSibling);
00615
00616 void
00617 <a class="code" href="class_xalansourcetreecomment.html#a37">setPreviousSibling</a>(<a class="code" href="class_xalansourcetreeprocessinginstruction.html">XalanSourceTreeProcessingInstruction</a>* thePreviousSibling);
00618
00619 void
00620 <a class="code" href="class_xalansourcetreecomment.html#a37">setPreviousSibling</a>(<a class="code" href="class_xalansourcetreetext.html">XalanSourceTreeText</a>* thePreviousSibling);
00621
00622 void
00623 <a class="code" href="class_xalansourcetreecomment.html#a41">appendSiblingNode</a>(<a class="code" href="class_xalansourcetreecomment.html">XalanSourceTreeComment</a>* theSibling);
00624
00625 void
00626 <a class="code" href="class_xalansourcetreecomment.html#a41">appendSiblingNode</a>(<a class="code" href="class_xalansourcetreeelement.html">XalanSourceTreeElement</a>* theSibling);
00627
00628 void
00629 <a class="code" href="class_xalansourcetreecomment.html#a41">appendSiblingNode</a>(<a class="code" href="class_xalansourcetreeprocessinginstruction.html">XalanSourceTreeProcessingInstruction</a>* theSibling);
00630
00631 void
00632 <a class="code" href="class_xalansourcetreecomment.html#a41">appendSiblingNode</a>(<a class="code" href="class_xalansourcetreetext.html">XalanSourceTreeText</a>* theSibling);
00633
00634 void
<a name="l00635"><a class="code" href="class_xalansourcetreecomment.html#a45">00635</a></a> <a class="code" href="class_xalansourcetreecomment.html#a45">setIndex</a>(unsigned int theIndex)
00636 {
00637 m_index = theIndex;
00638 }
00639
00640 protected:
00641
00642 <a class="code" href="class_xalansourcetreecomment.html#a0">XalanSourceTreeComment</a>(
00643 const <a class="code" href="class_xalansourcetreecomment.html">XalanSourceTreeComment</a>& theSource,
00644 bool deep = false);
00645
00646 private:
00647
00648 // Not implemented...
00649 <a class="code" href="class_xalansourcetreecomment.html">XalanSourceTreeComment</a>&
00650 operator=(const <a class="code" href="class_xalansourcetreecomment.html">XalanSourceTreeComment</a>& theSource);
00651
00652 bool
00653 operator==(const <a class="code" href="class_xalansourcetreecomment.html">XalanSourceTreeComment</a>& theRHS) const;
00654
00655
00656 // Data members...
00657 const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>& m_data;
00658
00659 <a class="code" href="class_xalansourcetreedocument.html">XalanSourceTreeDocument</a>* m_ownerDocument;
00660
00661 <a class="code" href="class_xalannode.html">XalanNode</a>* m_parentNode;
00662
00663 <a class="code" href="class_xalannode.html">XalanNode</a>* m_previousSibling;
00664
00665 <a class="code" href="class_xalannode.html">XalanNode</a>* m_nextSibling;
00666
00667 unsigned int m_index;
00668
00669 static const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>& s_nameString;
00670 };
00671
00672
00673
00674 #endif // !defined(XALANSOURCETREECOMMENT_HEADER_GUARD_1357924680)
</div></pre><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="images/dot.gif" width="1"></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.4</B><BR>
Copyright © 2000, 2001, 2002 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">
</TD>
</TR>
</TABLE>
