DOM_DocumentFragment.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_DocumentFragment.hpp,v 1.3 2002/11/04 15:04:44 tng Exp $
  58.  */
  59. #ifndef DOM_DocumentFragment_HEADER_GUARD_
  60. #define DOM_DocumentFragment_HEADER_GUARD_
  61. #include <xercesc/util/XercesDefs.hpp>
  62. #include "DOM_Node.hpp"
  63. XERCES_CPP_NAMESPACE_BEGIN
  64. class DocumentFragmentImpl;
  65. /**
  66.  * <code>DocumentFragment</code> is a "lightweight" or "minimal"
  67.  * <code>Document</code> object.
  68.  *
  69.  * It is very common to want to be able to
  70.  * extract a portion of a document's tree or to create a new fragment of a
  71.  * document. Imagine implementing a user command like cut or rearranging a
  72.  * document by moving fragments around. It is desirable to have an object
  73.  * which can hold such fragments and it is quite natural to use a Node for
  74.  * this purpose. While it is true that a <code>Document</code> object could
  75.  * fulfil this role,  a <code>Document</code> object can potentially be a
  76.  * heavyweight  object, depending on the underlying implementation. What is
  77.  * really needed for this is a very lightweight object.
  78.  * <code>DocumentFragment</code> is such an object.
  79.  * <p>Furthermore, various operations -- such as inserting nodes as children
  80.  * of another <code>Node</code> -- may take <code>DocumentFragment</code>
  81.  * objects as arguments;  this results in all the child nodes of the
  82.  * <code>DocumentFragment</code>  being moved to the child list of this node.
  83.  * <p>The children of a <code>DocumentFragment</code> node are zero or more
  84.  * nodes representing the tops of any sub-trees defining the structure of the
  85.  * document. <code>DocumentFragment</code> nodes do not need to be
  86.  * well-formed XML documents (although they do need to follow the rules
  87.  * imposed upon well-formed XML parsed entities, which can have multiple top
  88.  * nodes).  For example, a <code>DocumentFragment</code> might have only one
  89.  * child and that child node could be a <code>Text</code> node. Such a
  90.  * structure model  represents neither an HTML document nor a well-formed XML
  91.  * document.
  92.  * <p>When a <code>DocumentFragment</code> is inserted into a
  93.  * <code>Document</code> (or indeed any other <code>Node</code> that may take
  94.  * children) the children of the <code>DocumentFragment</code> and not the
  95.  * <code>DocumentFragment</code>  itself are inserted into the
  96.  * <code>Node</code>. This makes the <code>DocumentFragment</code> very
  97.  * useful when the user wishes to create nodes that are siblings; the
  98.  * <code>DocumentFragment</code> acts as the parent of these nodes so that the
  99.  *  user can use the standard methods from the <code>Node</code>  interface,
  100.  * such as <code>insertBefore()</code> and  <code>appendChild()</code>.
  101.  */
  102. class CDOM_EXPORT DOM_DocumentFragment: public DOM_Node {
  103. public:
  104.     /** @name Constructors and assignment operators */
  105.     //@{
  106.     /**
  107.     * Default constructor for <code>DOM_DocumentFragment</code>.  The resulting object does not
  108.     * refer to an actual Document Fragment node; it will compare == to 0, and is similar
  109.     * to a null object reference variable in Java.  It may subsequently be
  110.     * assigned to refer to an actual Document Fragment node.
  111.     * <p>
  112.     * New document fragment nodes are created by DOM_Document::createDocumentFragment().
  113.     *
  114.     */
  115.     DOM_DocumentFragment();
  116.     /**
  117.       * Copy constructor.  Creates a new <code>DOM_DocumentFragment</code> that refers to the
  118.       *   same underlying node as the original.  See also DOM_Node::clone(),
  119.       * which will copy the actual Document fragment node, rather than just creating a new
  120.       * reference to the original node.
  121.       *
  122.       * @param other The object to be copied
  123.       */
  124.     DOM_DocumentFragment(const DOM_DocumentFragment &other);
  125.     /**
  126.       * Assignment operator
  127.       *
  128.       * @param other The object to be copied
  129.       */
  130.     DOM_DocumentFragment & operator = (const DOM_DocumentFragment &other);
  131.     /**
  132.       * Assignment operator.  This overloaded variant is provided for
  133.       *   the sole purpose of setting a DOM_Node reference variable to
  134.       *   zero.  Nulling out a reference variable in this way will decrement
  135.       *   the reference count on the underlying Node object that the variable
  136.       *   formerly referenced.  This effect is normally obtained when reference
  137.       *   variable goes out of scope, but zeroing them can be useful for
  138.       *   global instances, or for local instances that will remain in scope
  139.       *   for an extended time,  when the storage belonging to the underlying
  140.       *   node needs to be reclaimed.
  141.       *
  142.       * @param val   Only a value of 0, or null, is allowed.
  143.       */
  144.     DOM_DocumentFragment & operator = (const DOM_NullPtr *val);
  145. //@}
  146.     /** @name Destructor */
  147.     //@{
  148.     /**
  149.       * Destructor.  The object being destroyed is the reference
  150.       * object, not the underlying Comment node itself.
  151.       *
  152.       */
  153.     ~DOM_DocumentFragment();
  154. //@}
  155. protected:
  156.     DOM_DocumentFragment(DocumentFragmentImpl *);
  157.     friend class DOM_Document;
  158.     friend class RangeImpl;
  159. };
  160. XERCES_CPP_NAMESPACE_END
  161. #endif