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(XALANCHARACTERDATA_HEADER_GUARD_1357924680)
00017 #define XALANCHARACTERDATA_HEADER_GUARD_1357924680
00018 
00019 
00020 
00021 #include <xalanc/XalanDOM/XalanDOMDefinitions.hpp>
00022 #include <xalanc/XalanDOM/XalanNode.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 CharacterData interface.
00034  *
00035  * This class is experimental and subject to change!!
00036  */
00037 
00038 class XALAN_DOM_EXPORT XalanCharacterData : public XalanNode
00039 {
00040 public:
00041 
00042     XalanCharacterData();
00043 
00044     virtual
00045     ~XalanCharacterData();
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 XalanCharacterData*
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 
00270     virtual void
00271     setNodeValue(const XalanDOMString&  nodeValue) = 0;
00272 
00274 
00276 
00293     virtual void
00294     normalize() = 0;
00295 
00309     virtual bool
00310     isSupported(
00311             const XalanDOMString&   feature,
00312             const XalanDOMString&   version) const = 0;
00313 
00327     virtual const XalanDOMString&
00328     getNamespaceURI() const = 0;
00329 
00334     virtual const XalanDOMString&
00335     getPrefix() const = 0;
00336 
00344     virtual const XalanDOMString&
00345     getLocalName() const = 0;
00346 
00376     virtual void
00377     setPrefix(const XalanDOMString&     prefix) = 0;
00378 
00384     virtual bool
00385     isIndexed() const = 0;
00386 
00393     virtual IndexType
00394     getIndex() const = 0;
00395 
00397 
00398     // These interfaces are new to XalanCharacterData...
00399 
00402 
00418     virtual const XalanDOMString&
00419     getData() const = 0;
00420 
00428     virtual unsigned int
00429     getLength() const = 0;
00430 
00446     virtual XalanDOMString&
00447     substringData(
00448             unsigned int    offset, 
00449             unsigned int    count,
00450             XalanDOMString& theResult) const = 0;
00451 
00453 
00455 
00464     virtual void
00465     appendData(const XalanDOMString&    arg) = 0;
00466 
00477     virtual void
00478     insertData(
00479             unsigned int            offset,
00480             const  XalanDOMString&  arg) = 0;
00481 
00498     virtual void
00499     deleteData(
00500             unsigned int    offset, 
00501             unsigned int    count) = 0;
00502 
00521     virtual void
00522     replaceData(
00523             unsigned int            offset, 
00524             unsigned int            count, 
00525             const XalanDOMString&   arg) = 0;
00526 
00528 
00529 protected:
00530 
00531     XalanCharacterData(const XalanCharacterData&    theSource);
00532 
00533     XalanCharacterData&
00534     operator=(const XalanCharacterData&     theSource);
00535 
00536     bool
00537     operator==(const XalanCharacterData&    theRHS) const;
00538 
00539 private:
00540 };
00541 
00542 
00543 
00544 XALAN_CPP_NAMESPACE_END
00545 
00546 
00547 
00548 #endif  // !defined(XALANCHARACTERDATA_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

XalanCharacterData.hpp
