DOM_Text.hpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:8k
源码类别:

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  * 
  4.  * Copyright (c) 1999-2000 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.  * $Log: DOM_Text.hpp,v $
  58.  * Revision 1.8  2000/07/28 01:33:31  aruna1
  59.  * DOM Level 2 Range feature introduced
  60.  *
  61.  * Revision 1.7  2000/03/24 01:30:50  chchou
  62.  * Fix bug #8 to support ignorable whitespace text nodes
  63.  *
  64.  * Revision 1.6  2000/03/02 19:53:57  roddey
  65.  * This checkin includes many changes done while waiting for the
  66.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  67.  * available elsewhere.
  68.  *
  69.  * Revision 1.5  2000/02/24 20:11:28  abagchi
  70.  * Swat for removing Log from API docs
  71.  *
  72.  * Revision 1.4  2000/02/06 07:47:31  rahulj
  73.  * Year 2K copyright swat.
  74.  *
  75.  * Revision 1.3  2000/02/04 01:49:27  aruna1
  76.  * TreeWalker and NodeIterator changes
  77.  *
  78.  * Revision 1.2  2000/01/05 01:16:08  andyh
  79.  * DOM Level 2 core, namespace support added.
  80.  *
  81.  * Revision 1.1.1.1  1999/11/09 01:09:04  twl
  82.  * Initial checkin
  83.  *
  84.  * Revision 1.2  1999/11/08 20:44:22  rahul
  85.  * Swat for adding in Product name and CVS comment log variable.
  86.  *
  87.  */
  88. #ifndef DOM_Text_HEADER_GUARD_
  89. #define DOM_Text_HEADER_GUARD_
  90. #include <util/XercesDefs.hpp>
  91. #include <dom/DOM_CharacterData.hpp>
  92. class TextImpl;
  93. /**
  94.  * The <code>Text</code> interface represents the textual content (termed 
  95.  * character  data in XML) of an <code>Element</code> or <code>Attr</code>.  
  96.  * If there is no markup inside an element's content, the text is contained 
  97.  * in a single object implementing the <code>Text</code> interface that is 
  98.  * the only child of the element. If there is markup, it is parsed into a 
  99.  * list of elements and <code>Text</code> nodes that form the list of 
  100.  * children of the element.
  101.  * <p>When a document is first made available via the DOM, there is  only one 
  102.  * <code>Text</code> node for each block of text. Users may create  adjacent 
  103.  * <code>Text</code> nodes that represent the  contents of a given element 
  104.  * without any intervening markup, but should be aware that there is no way 
  105.  * to represent the separations between these nodes in XML, so they 
  106.  * will not (in general) persist between DOM editing sessions. The 
  107.  * <code>normalize()</code> method on <code>Element</code> merges any such 
  108.  * adjacent <code>Text</code> objects into a single node for each block of 
  109.  * text; this is  recommended before employing operations that depend on a 
  110.  * particular document structure, such as navigation with 
  111.  * <code>XPointers.</code> 
  112.  */
  113. class CDOM_EXPORT DOM_Text: public DOM_CharacterData {
  114.     public:
  115.     /** @name Constructors and assignment operator */
  116.     //@{
  117.     /**
  118.       * Default constructor for DOM_Text.  The resulting object does not
  119.       * refer to an actual Text node; it will compare == to 0, and is similar
  120.       * to a null object reference variable in Java.  It may subsequently be
  121.       * assigned to refer to an actual comment node.
  122.       *
  123.       */
  124.     DOM_Text();
  125.     /**
  126.       * Copy constructor.  Creates a new <code>DOM_Text</code> that refers to the
  127.       * same underlying node as the original.  See also DOM_Node::clone(),
  128.       * which will copy the actual Text node, rather than just creating a new
  129.       * reference to the original node.
  130.       *
  131.       * @param other The object to be copied.
  132.       */
  133.     DOM_Text(const DOM_Text &other);
  134.     /**
  135.       * Assignment operator.
  136.       *
  137.       * @param other The object to be copied.
  138.       */
  139.     DOM_Text & operator = (const DOM_Text &other);
  140.     /**
  141.       * Assignment operator.  This overloaded variant is provided for
  142.       *   the sole purpose of setting a DOM_Node reference variable to
  143.       *   zero.  Nulling out a reference variable in this way will decrement
  144.       *   the reference count on the underlying Node object that the variable
  145.       *   formerly referenced.  This effect is normally obtained when reference
  146.       *   variable goes out of scope, but zeroing them can be useful for
  147.       *   global instances, or for local instances that will remain in scope
  148.       *   for an extended time,  when the storage belonging to the underlying
  149.       *   node needs to be reclaimed.
  150.       *
  151.       * @param val.  Only a value of 0, or null, is allowed.
  152.       */
  153.     DOM_Text & operator = (const DOM_NullPtr *val);
  154.     //@}
  155.     /** @name Destructor. */
  156.     //@{
  157.  /**
  158.   * Destructor for DOM_Text. The object being destroyed is the reference
  159.       * object, not the underlying Comment node itself.
  160.   *
  161.   */
  162.     ~DOM_Text();
  163.     //@}
  164.     /** @name Functions to modify the Text node. */
  165.     //@{
  166.     /**
  167.      * Breaks this node into two nodes at the specified 
  168.      * offset, keeping both in the tree as siblings. 
  169.      *
  170.      * This node then only 
  171.      * contains all the content up to the <code>offset</code> point. And a new 
  172.      * node of the same nodeType, which is inserted as the next sibling of this 
  173.      * node, contains all the content at and after the <code>offset</code> 
  174.      * point. When the <code>offset</code> is equal to the lenght of this node,
  175.      * the new node has no data.
  176.      * @param offset The offset at which to split, starting from 0.
  177.      * @return The new <code>Text</code> node.
  178.      * @exception DOMException
  179.      *   INDEX_SIZE_ERR: Raised if the specified offset is negative or greater 
  180.      *   than the number of characters in <code>data</code>.
  181.      *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
  182.      */
  183.     DOM_Text splitText(unsigned int offset);
  184.     //@}
  185.     /** @name Non-standard (not defined by the DOM specification) functions. */
  186.     //@{
  187.     /**
  188.      *
  189.      * <p><b>"Experimental - subject to change"</b></p>
  190.      *
  191.      * Return true if this node contains ignorable whitespaces only.
  192.      * @return True if this node contains ignorable whitespaces only.
  193.      */
  194.     bool isIgnorableWhitespace();
  195.     //@}
  196. protected:
  197.     DOM_Text(TextImpl *);
  198.     friend class DOM_Document;
  199.     friend class RangeImpl;
  200. };
  201. #endif