Xalan-C++ API Documentation

00001 /*
00002  * Copyright 1999-2004 The Apache Software Foundation.
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #if !defined(XALANCOMMENT_HEADER_GUARD_1357924680)
00017 #define XALANCOMMENT_HEADER_GUARD_1357924680
00018 
00019 
00020 
00021 #include <xalanc/XalanDOM/XalanDOMDefinitions.hpp>
00022 #include <xalanc/XalanDOM/XalanCharacterData.hpp>
00023 
00024 
00025 
00026 XALAN_CPP_NAMESPACE_BEGIN
00027 
00028 
00029 
00030 /*
00031  * <meta name="usage" content="experimental"/>
00032  *
00033  * Base class for the DOM Comment interface.
00034  *
00035  * This class is experimental and subject to change!!
00036  */
00037 
00038 class XALAN_DOM_EXPORT XalanComment : public XalanCharacterData
00039 {
00040 public:
00041 
00042     XalanComment();
00043 
00044     virtual
00045     ~XalanComment();
00046 
00047     // These interfaces are inherited from XalanNode...
00048     virtual const XalanDOMString&
00049     getNodeName() const = 0;
00050 
00054     virtual const XalanDOMString&
00055     getNodeValue() const = 0;
00056 
00060     virtual NodeType
00061     getNodeType() const = 0;
00062 
00072     virtual XalanNode*
00073     getParentNode() const = 0;
00074 
00088     virtual const XalanNodeList*
00089     getChildNodes() const = 0;
00090 
00096     virtual XalanNode*
00097     getFirstChild() const = 0;
00098 
00104     virtual XalanNode*
00105     getLastChild() const = 0;
00106 
00112     virtual XalanNode*
00113     getPreviousSibling() const = 0;
00114 
00120     virtual XalanNode*
00121     getNextSibling() const = 0;
00122 
00127     virtual const XalanNamedNodeMap*
00128     getAttributes() const = 0;
00129 
00139     virtual XalanDocument*
00140     getOwnerDocument() const = 0;
00141 
00143 
00145 
00164 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00165     virtual XalanNode*
00166 #else
00167     virtual XalanComment*
00168 #endif
00169     cloneNode(bool deep) const = 0;
00170 
00172 
00174 
00191     virtual XalanNode*
00192     insertBefore(
00193             XalanNode*  newChild,
00194             XalanNode*  refChild) = 0;
00195 
00209     virtual XalanNode*
00210     replaceChild(
00211             XalanNode*  newChild,
00212             XalanNode*  oldChild) = 0;
00213 
00221     virtual XalanNode*
00222     removeChild(XalanNode*  oldChild) = 0;
00223 
00235     virtual XalanNode*
00236     appendChild(XalanNode*  newChild) = 0;
00237 
00239 
00241 
00249     virtual bool
00250     hasChildNodes() const = 0;
00251 
00252 
00254 
00256 
00257 
00271     virtual void
00272     setNodeValue(const XalanDOMString&  nodeValue) = 0;
00273 
00275 
00277 
00294     virtual void
00295     normalize() = 0;
00296 
00310     virtual bool
00311     isSupported(
00312             const XalanDOMString&   feature,
00313             const XalanDOMString&   version) const = 0;
00314 
00328     virtual const XalanDOMString&
00329     getNamespaceURI() const = 0;
00330 
00335     virtual const XalanDOMString&
00336     getPrefix() const = 0;
00337 
00345     virtual const XalanDOMString&
00346     getLocalName() const = 0;
00347 
00377     virtual void
00378     setPrefix(const XalanDOMString& prefix) = 0;
00379 
00385     virtual bool
00386     isIndexed() const = 0;
00387 
00394     virtual IndexType
00395     getIndex() const = 0;
00396 
00398 
00399     // These interfaces are inherited from XalanCharacterData...
00400 
00403 
00419     virtual const XalanDOMString&
00420     getData() const = 0;
00421 
00429     virtual unsigned int
00430     getLength() const = 0;
00431 
00447     virtual XalanDOMString&
00448     substringData(
00449             unsigned int    offset, 
00450             unsigned int    count,
00451             XalanDOMString& theResult) const = 0;
00452 
00454 
00456 
00465     virtual void
00466     appendData(const XalanDOMString&    arg) = 0;
00467 
00478     virtual void
00479     insertData(
00480             unsigned int            offset,
00481             const  XalanDOMString&  arg) = 0;
00482 
00499     virtual void
00500     deleteData(
00501             unsigned int    offset, 
00502             unsigned int    count) = 0;
00503 
00522     virtual void
00523     replaceData(
00524             unsigned int        offset, 
00525             unsigned int        count, 
00526             const XalanDOMString&   arg) = 0;
00527 
00529 
00530 protected:
00531 
00532     XalanComment(const XalanComment&    theSource);
00533 
00534     XalanComment&
00535     operator=(const XalanComment&   theSource);
00536 
00537     bool
00538     operator==(const XalanComment&  theRHS) const;
00539 
00540 private:
00541 };
00542 
00543 
00544 
00545 XALAN_CPP_NAMESPACE_END
00546 
00547 
00548 
00549 #endif  // !defined(XALANCOMMENT_HEADER_GUARD_1357924680)
Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.
Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

XalanComment.hpp
