| /* |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 1999 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Xerces" and "Apache Software Foundation" must |
| * not be used to endorse or promote products derived from this |
| * software without prior written permission. For written |
| * permission, please contact apache\@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * nor may "Apache" appear in their name, without prior written |
| * permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation, and was |
| * originally based on software copyright (c) 1999, International |
| * Business Machines, Inc., http://www.ibm.com . For more information |
| * on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| */ |
| |
| /** |
| * $Log$ |
| * Revision 1.1 1999/11/09 01:08:49 twl |
| * Initial revision |
| * |
| * Revision 1.2 1999/11/08 20:44:13 rahul |
| * Swat for adding in Product name and CVS comment log variable. |
| * |
| */ |
| |
| #ifndef DOM_CharacterData_HEADER_GUARD_ |
| #define DOM_CharacterData_HEADER_GUARD_ |
| |
| #include <util/XML4CDefs.hpp> |
| #include <dom/DOM_Node.hpp> |
| |
| class CharacterDataImpl; |
| |
| /** |
| * The <code>DOM_CharacterData</code> interface extends Node with a set of |
| * methods for accessing character data in the DOM. |
| * |
| * For clarity this set is defined here rather than on each class that uses |
| * these methods. No DOM objects correspond directly to |
| * <code>CharacterData</code>, though <code>Text</code> and others do inherit |
| * the interface from it. All <code>offset</code>s in this interface start |
| * from 0, and index in terms of Unicode 16 bit storage units. |
| */ |
| class CDOM_EXPORT DOM_CharacterData: public DOM_Node { |
| |
| private: |
| |
| public: |
| /** @name Constructors and assignment operator */ |
| //@{ |
| /** |
| * Default constructor for DOM_CharacterData. While there can be |
| * no actual DOM nodes of type CharacterData, the C++ objects |
| * function more like reference variables, and instances of |
| * <code>DOM_CharacterData</code> can exist. They will be null when created |
| * by this constructor, and can then be assigned to refer to Text |
| * or CDATASection nodes. |
| */ |
| DOM_CharacterData(); |
| |
| /** |
| * Copy constructor |
| * |
| * @param other The object to be copied |
| */ |
| DOM_CharacterData(const DOM_CharacterData &other); |
| /** |
| * Assignment operator |
| * |
| * @param other The object to be copied |
| */ |
| DOM_CharacterData & operator = (const DOM_CharacterData &other); |
| |
| //@} |
| /** @name Destructor. */ |
| //@{ |
| /** |
| * Destructor for DOM_CharacterData. The object being destroyed |
| * is the reference to the Character Data node, not the character |
| * data itself. |
| */ |
| ~DOM_CharacterData(); |
| |
| /** |
| * Assignment operator. This overloaded variant is provided for |
| * the sole purpose of setting a DOM_Node reference variable to |
| * zero. Nulling out a reference variable in this way will decrement |
| * the reference count on the underlying Node object that the variable |
| * formerly referenced. This effect is normally obtained when reference |
| * variable goes out of scope, but zeroing them can be useful for |
| * global instances, or for local instances that will remain in scope |
| * for an extended time, when the storage belonging to the underlying |
| * node needs to be reclaimed. |
| * |
| * @param val. Only a value of 0, or null, is allowed. |
| */ |
| DOM_CharacterData & operator = (const DOM_NullPtr *val); |
| |
| |
| //@} |
| |
| /** @name Getter functions. */ |
| //@{ |
| /** |
| * Returns the character data of the node that implements this interface. |
| * |
| * The DOM implementation may not put arbitrary limits on the amount of data that |
| * may be stored in a <code>CharacterData</code> node. However, |
| * implementation limits may mean that the entirety of a node's data may |
| * not fit into a single <code>DOMString</code>. In such cases, the user |
| * may call <code>substringData</code> to retrieve the data in |
| * appropriately sized pieces. |
| * @exception DOMException |
| * NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. |
| * @exception DOMException |
| * DOMSTRING_SIZE_ERR: Raised when it would return more characters than |
| * fit in a <code>DOMString</code> variable on the implementation |
| * platform. |
| */ |
| DOMString getData() const; |
| /** |
| * Returns the number of characters that are available through <code>data</code> and |
| * the <code>substringData</code> method below. |
| * |
| * This may have the value |
| * zero, i.e., <code>CharacterData</code> nodes may be empty. |
| */ |
| int getLength() const; |
| /** |
| * Extracts a range of data from the node. |
| * |
| * @param offset Start offset of substring to extract. |
| * @param count The number of characters to extract. |
| * @return The specified substring. If the sum of <code>offset</code> and |
| * <code>count</code> exceeds the <code>length</code>, then all |
| * characters to the end of the data are returned. |
| * @exception DOMException |
| * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater |
| * than the number of characters in <code>data</code>, or if the |
| * specified <code>count</code> is negative. |
| * <br>DOMSTRING_SIZE_ERR: Raised if the specified range of text does not |
| * fit into a <code>DOMString</code>. |
| */ |
| DOMString substringData(int offset, |
| int count) const; |
| //@} |
| /** @name Functions that set or change data. */ |
| //@{ |
| /** |
| * Append the string to the end of the character data of the node. |
| * |
| * Upon success, <code>data</code> provides access to the concatenation of |
| * <code>data</code> and the <code>DOMString</code> specified. |
| * @param arg The <code>DOMString</code> to append. |
| * @exception DOMException |
| * NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
| */ |
| void appendData(const DOMString &arg); |
| /** |
| * Insert a string at the specified character offset. |
| * |
| * @param offset The character offset at which to insert. |
| * @param arg The <code>DOMString</code> to insert. |
| * @exception DOMException |
| * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater |
| * than the number of characters in <code>data</code>. |
| * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
| */ |
| void insertData(int offset, const DOMString &arg); |
| /** |
| * Remove a range of characters from the node. |
| * |
| * Upon success, |
| * <code>data</code> and <code>length</code> reflect the change. |
| * @param offset The offset from which to remove characters. |
| * @param count The number of characters to delete. If the sum of |
| * <code>offset</code> and <code>count</code> exceeds <code>length</code> |
| * then all characters from <code>offset</code> to the end of the data |
| * are deleted. |
| * @exception DOMException |
| * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater |
| * than the number of characters in <code>data</code>, or if the |
| * specified <code>count</code> is negative. |
| * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
| */ |
| void deleteData(int offset, |
| int count); |
| /** |
| * Replace the characters starting at the specified character offset with |
| * the specified string. |
| * |
| * @param offset The offset from which to start replacing. |
| * @param count The number of characters to replace. If the sum of |
| * <code>offset</code> and <code>count</code> exceeds <code>length</code> |
| * , then all characters to the end of the data are replaced (i.e., the |
| * effect is the same as a <code>remove</code> method call with the same |
| * range, followed by an <code>append</code> method invocation). |
| * @param arg The <code>DOMString</code> with which the range must be |
| * replaced. |
| * @exception DOMException |
| * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater |
| * than the number of characters in <code>data</code>, or if the |
| * specified <code>count</code> is negative. |
| * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
| */ |
| void replaceData(int offset, |
| int count, |
| const DOMString &arg); |
| |
| /** |
| * Sets the character data of the node that implements this interface. |
| * |
| * @param data The <code>DOMString</code> to set. |
| */ |
| void setData(const DOMString &data); |
| //@} |
| |
| protected: |
| DOM_CharacterData(CharacterDataImpl *impl); |
| |
| }; |
| |
| #endif |
| |
| |
