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

词法分析

开发平台:

Visual C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Xerces" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation, and was
  51.  * originally based on software copyright (c) 1999, International
  52.  * Business Machines, Inc., http://www.ibm.com .  For more information
  53.  * on the Apache Software Foundation, please see
  54.  * <http://www.apache.org/>.
  55.  */
  56. /*
  57.  * $Id: DOM_Text.hpp,v 1.3 2002/11/04 15:04:44 tng Exp $
  58.  */
  59. #ifndef DOM_Text_HEADER_GUARD_
  60. #define DOM_Text_HEADER_GUARD_
  61. #include <xercesc/util/XercesDefs.hpp>
  62. #include "DOM_CharacterData.hpp"
  63. XERCES_CPP_NAMESPACE_BEGIN
  64. class TextImpl;
  65. /**
  66.  * The <code>Text</code> interface represents the textual content (termed
  67.  * character  data in XML) of an <code>Element</code> or <code>Attr</code>.
  68.  * If there is no markup inside an element's content, the text is contained
  69.  * in a single object implementing the <code>Text</code> interface that is
  70.  * the only child of the element. If there is markup, it is parsed into a
  71.  * list of elements and <code>Text</code> nodes that form the list of
  72.  * children of the element.
  73.  * <p>When a document is first made available via the DOM, there is  only one
  74.  * <code>Text</code> node for each block of text. Users may create  adjacent
  75.  * <code>Text</code> nodes that represent the  contents of a given element
  76.  * without any intervening markup, but should be aware that there is no way
  77.  * to represent the separations between these nodes in XML, so they
  78.  * will not (in general) persist between DOM editing sessions. The
  79.  * <code>normalize()</code> method on <code>Element</code> merges any such
  80.  * adjacent <code>Text</code> objects into a single node for each block of
  81.  * text; this is  recommended before employing operations that depend on a
  82.  * particular document structure, such as navigation with
  83.  * <code>XPointers.</code>
  84.  */
  85. class CDOM_EXPORT DOM_Text: public DOM_CharacterData {
  86.     public:
  87.     /** @name Constructors and assignment operator */
  88.     //@{
  89.     /**
  90.       * Default constructor for DOM_Text.  The resulting object does not
  91.       * refer to an actual Text node; it will compare == to 0, and is similar
  92.       * to a null object reference variable in Java.  It may subsequently be
  93.       * assigned to refer to an actual comment node.
  94.       *
  95.       */
  96.     DOM_Text();
  97.     /**
  98.       * Copy constructor.  Creates a new <code>DOM_Text</code> that refers to the
  99.       * same underlying node as the original.  See also DOM_Node::clone(),
  100.       * which will copy the actual Text node, rather than just creating a new
  101.       * reference to the original node.
  102.       *
  103.       * @param other The object to be copied.
  104.       */
  105.     DOM_Text(const DOM_Text &other);
  106.     /**
  107.       * Assignment operator.
  108.       *
  109.       * @param other The object to be copied.
  110.       */
  111.     DOM_Text & operator = (const DOM_Text &other);
  112.     /**
  113.       * Assignment operator.  This overloaded variant is provided for
  114.       *   the sole purpose of setting a DOM_Node reference variable to
  115.       *   zero.  Nulling out a reference variable in this way will decrement
  116.       *   the reference count on the underlying Node object that the variable
  117.       *   formerly referenced.  This effect is normally obtained when reference
  118.       *   variable goes out of scope, but zeroing them can be useful for
  119.       *   global instances, or for local instances that will remain in scope
  120.       *   for an extended time,  when the storage belonging to the underlying
  121.       *   node needs to be reclaimed.
  122.       *
  123.       * @param val  Only a value of 0, or null, is allowed.
  124.       */
  125.     DOM_Text & operator = (const DOM_NullPtr *val);
  126.     //@}
  127.     /** @name Destructor. */
  128.     //@{
  129.  /**
  130.   * Destructor for DOM_Text. The object being destroyed is the reference
  131.       * object, not the underlying Comment node itself.
  132.   *
  133.   */
  134.     ~DOM_Text();
  135.     //@}
  136.     /** @name Functions to modify the Text node. */
  137.     //@{
  138.     /**
  139.      * Breaks this node into two nodes at the specified
  140.      * offset, keeping both in the tree as siblings.
  141.      *
  142.      * This node then only
  143.      * contains all the content up to the <code>offset</code> point. And a new
  144.      * node of the same nodeType, which is inserted as the next sibling of this
  145.      * node, contains all the content at and after the <code>offset</code>
  146.      * point. When the <code>offset</code> is equal to the lenght of this node,
  147.      * the new node has no data.
  148.      * @param offset The offset at which to split, starting from 0.
  149.      * @return The new <code>Text</code> node.
  150.      * @exception DOMException
  151.      *   INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
  152.      *   than the number of characters in <code>data</code>.
  153.      *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
  154.      */
  155.     DOM_Text splitText(unsigned int offset);
  156.     //@}
  157.     /** @name Non-standard (not defined by the DOM specification) functions. */
  158.     //@{
  159.     /**
  160.      *
  161.      * Return true if this node contains ignorable whitespaces only.
  162.      * @return True if this node contains ignorable whitespaces only.
  163.      */
  164.     bool isIgnorableWhitespace();
  165.     //@}
  166. protected:
  167.     DOM_Text(TextImpl *);
  168.     friend class DOM_Document;
  169.     friend class RangeImpl;
  170. };
  171. XERCES_CPP_NAMESPACE_END
  172. #endif