source: NonGTP/Xerces/xercesc/dom/deprecated/DOM_DocumentFragment.hpp @ 188

Revision 188, 7.7 KB checked in by mattausch, 19 years ago (diff)

added xercesc to support

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