DOMCharacterData.hpp
上传用户:zhuqijet
上传日期:2013-06-25
资源大小:10074k
文件大小:11k
源码类别:

词法分析

开发平台:

Visual C++

  1. #ifndef DOMCharacterData_HEADER_GUARD_
  2. #define DOMCharacterData_HEADER_GUARD_
  3. /*
  4.  * The Apache Software License, Version 1.1
  5.  *
  6.  * Copyright (c) 2001-2002 The Apache Software Foundation.  All rights
  7.  * reserved.
  8.  *
  9.  * Redistribution and use in source and binary forms, with or without
  10.  * modification, are permitted provided that the following conditions
  11.  * are met:
  12.  *
  13.  * 1. Redistributions of source code must retain the above copyright
  14.  *    notice, this list of conditions and the following disclaimer.
  15.  *
  16.  * 2. Redistributions in binary form must reproduce the above copyright
  17.  *    notice, this list of conditions and the following disclaimer in
  18.  *    the documentation and/or other materials provided with the
  19.  *    distribution.
  20.  *
  21.  * 3. The end-user documentation included with the redistribution,
  22.  *    if any, must include the following acknowledgment:
  23.  *       "This product includes software developed by the
  24.  *        Apache Software Foundation (http://www.apache.org/)."
  25.  *    Alternately, this acknowledgment may appear in the software itself,
  26.  *    if and wherever such third-party acknowledgments normally appear.
  27.  *
  28.  * 4. The names "Xerces" and "Apache Software Foundation" must
  29.  *    not be used to endorse or promote products derived from this
  30.  *    software without prior written permission. For written
  31.  *    permission, please contact apache@apache.org.
  32.  *
  33.  * 5. Products derived from this software may not be called "Apache",
  34.  *    nor may "Apache" appear in their name, without prior written
  35.  *    permission of the Apache Software Foundation.
  36.  *
  37.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  38.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  39.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  40.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  41.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  42.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  43.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  44.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  45.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  46.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  47.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  48.  * SUCH DAMAGE.
  49.  * ====================================================================
  50.  *
  51.  * This software consists of voluntary contributions made by many
  52.  * individuals on behalf of the Apache Software Foundation, and was
  53.  * originally based on software copyright (c) 2001, International
  54.  * Business Machines, Inc., http://www.ibm.com .  For more information
  55.  * on the Apache Software Foundation, please see
  56.  * <http://www.apache.org/>.
  57.  */
  58. /*
  59.  * $Id: DOMCharacterData.hpp,v 1.8 2003/03/07 19:59:01 tng Exp $
  60.  */
  61. #include <xercesc/util/XercesDefs.hpp>
  62. #include <xercesc/dom/DOMNode.hpp>
  63. XERCES_CPP_NAMESPACE_BEGIN
  64. /**
  65.  * The <code>DOMCharacterData</code> interface extends DOMNode with a set of
  66.  * attributes and methods for accessing character data in the DOM. For
  67.  * clarity this set is defined here rather than on each object that uses
  68.  * these attributes and methods. No DOM objects correspond directly to
  69.  * <code>DOMCharacterData</code>, though <code>DOMText</code> and others do
  70.  * inherit the interface from it. All <code>offsets</code> in this interface
  71.  * start from <code>0</code>.
  72.  * <p>As explained in the DOM spec, text strings in
  73.  * the DOM are represented in UTF-16, i.e. as a sequence of 16-bit units. In
  74.  * the following, the term 16-bit units is used whenever necessary to
  75.  * indicate that indexing on DOMCharacterData is done in 16-bit units.
  76.  * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113'>Document Object Model (DOM) Level 2 Core Specification</a>.
  77.  * @since DOM Level 1
  78.  */
  79. class CDOM_EXPORT DOMCharacterData: public DOMNode {
  80. protected:
  81.     // -----------------------------------------------------------------------
  82.     //  Hidden constructors
  83.     // -----------------------------------------------------------------------
  84.     /** @name Hidden constructors */
  85.     //@{    
  86.     DOMCharacterData() {};
  87.     //@}
  88. private:
  89.     // -----------------------------------------------------------------------
  90.     // Unimplemented constructors and operators
  91.     // -----------------------------------------------------------------------
  92.     /** @name Unimplemented constructors and operators */
  93.     //@{
  94.     DOMCharacterData(const DOMCharacterData &);
  95.     DOMCharacterData & operator = (const DOMCharacterData &);
  96.     //@}
  97. public:
  98.     // -----------------------------------------------------------------------
  99.     //  All constructors are hidden, just the destructor is available
  100.     // -----------------------------------------------------------------------
  101.     /** @name Destructor */
  102.     //@{
  103.     /**
  104.      * Destructor
  105.      *
  106.      */
  107.     virtual ~DOMCharacterData() {};
  108.     //@}
  109.     // -----------------------------------------------------------------------
  110.     //  Virtual DOMCharacterData interface
  111.     // -----------------------------------------------------------------------
  112.     /** @name Functions introduced in DOM Level 1 */
  113.     //@{
  114.     // -----------------------------------------------------------------------
  115.     //  Getter methods
  116.     // -----------------------------------------------------------------------
  117.     /**
  118.      * Returns the character data of the node that implements this interface.
  119.      *
  120.      * The DOM implementation may not put arbitrary limits on the amount of data that
  121.      * may be stored in a  <code>DOMCharacterData</code> node. However,
  122.      * implementation limits may  mean that the entirety of a node's data may
  123.      * not fit into a single <code>XMLCh* String</code>. In such cases, the user
  124.      * may call <code>substringData</code> to retrieve the data in
  125.      * appropriately sized pieces.
  126.      * @exception DOMException
  127.      *   NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
  128.      * @since DOM Level 1
  129.      */
  130.     virtual const XMLCh *     getData() const = 0;
  131.     /**
  132.      * Returns the number of characters that are available through <code>data</code> and
  133.      * the <code>substringData</code> method below.
  134.      *
  135.      * This may have the value
  136.      * zero, i.e., <code>CharacterData</code> nodes may be empty.
  137.      * @since DOM Level 1
  138.      */
  139.     virtual XMLSize_t       getLength() const = 0;
  140.     /**
  141.      * Extracts a range of data from the node.
  142.      *
  143.      * @param offset Start offset of substring to extract.
  144.      * @param count The number of characters to extract.
  145.      * @return The specified substring. If the sum of <code>offset</code> and
  146.      *   <code>count</code> exceeds the <code>length</code>, then all
  147.      *   characters to the end of the data are returned.
  148.      * @exception DOMException
  149.      *   INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
  150.      *   than the number of characters in <code>data</code>, or if the
  151.      *   specified <code>count</code> is negative.
  152.      * @since DOM Level 1
  153.      */
  154.     virtual const XMLCh *     substringData(XMLSize_t offset,
  155.                                      XMLSize_t count) const = 0;
  156.     // -----------------------------------------------------------------------
  157.     //  String methods
  158.     // -----------------------------------------------------------------------
  159.     /**
  160.      * Append the string to the end of the character data of the node.
  161.      *
  162.      * Upon success, <code>data</code> provides access to the concatenation of
  163.      * <code>data</code> and the <code>XMLCh* String</code> specified.
  164.      * @param arg The <code>XMLCh* String</code> to append.
  165.      * @exception DOMException
  166.      *   NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
  167.      * @since DOM Level 1
  168.      */
  169.     virtual void               appendData(const XMLCh *arg) = 0;
  170.     /**
  171.      * Insert a string at the specified character offset.
  172.      *
  173.      * @param offset The character offset at which to insert.
  174.      * @param arg The <code>XMLCh* String</code> to insert.
  175.      * @exception DOMException
  176.      *   INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
  177.      *   than the number of characters in <code>data</code>.
  178.      *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
  179.      * @since DOM Level 1
  180.      */
  181.     virtual void               insertData(XMLSize_t offset, const  XMLCh *arg) = 0;
  182.     /**
  183.      * Remove a range of characters from the node.
  184.      *
  185.      * Upon success,
  186.      * <code>data</code> and <code>length</code> reflect the change.
  187.      * @param offset The offset from which to remove characters.
  188.      * @param count The number of characters to delete. If the sum of
  189.      *   <code>offset</code> and <code>count</code> exceeds <code>length</code>
  190.      *   then all characters from <code>offset</code> to the end of the data
  191.      *   are deleted.
  192.      * @exception DOMException
  193.      *   INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
  194.      *   than the number of characters in <code>data</code>, or if the
  195.      *   specified <code>count</code> is negative.
  196.      *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
  197.      * @since DOM Level 1
  198.      */
  199.     virtual void               deleteData(XMLSize_t offset,
  200.                                   XMLSize_t count) = 0;
  201.     /**
  202.      * Replace the characters starting at the specified character offset with
  203.      * the specified string.
  204.      *
  205.      * @param offset The offset from which to start replacing.
  206.      * @param count The number of characters to replace. If the sum of
  207.      *   <code>offset</code> and <code>count</code> exceeds <code>length</code>
  208.      *   , then all characters to the end of the data are replaced (i.e., the
  209.      *   effect is the same as a <code>remove</code> method call with the same
  210.      *   range, followed by an <code>append</code> method invocation).
  211.      * @param arg The <code>XMLCh* String</code> with which the range must be
  212.      *   replaced.
  213.      * @exception DOMException
  214.      *   INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
  215.      *   than the number of characters in <code>data</code>, or if the
  216.      *   specified <code>count</code> is negative.
  217.      *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
  218.      * @since DOM Level 1
  219.      */
  220.     virtual void               replaceData(XMLSize_t offset,
  221.                                    XMLSize_t count,
  222.                                    const XMLCh *arg) = 0;
  223.     /**
  224.      * Sets the character data of the node that implements this interface.
  225.      *
  226.      * @param data The <code>XMLCh* String</code> to set.
  227.      * @since DOM Level 1
  228.      */
  229.     virtual void               setData(const XMLCh *data) = 0;
  230.     //@}
  231. };
  232. XERCES_CPP_NAMESPACE_END
  233. #endif