source: NonGTP/Xerces/xerces-c_2_8_0/include/xercesc/dom/deprecated/DOM_CDATASection.hpp @ 2674

Revision 2674, 3.7 KB checked in by mattausch, 16 years ago (diff)
Line 
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements.  See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License.  You may obtain a copy of the License at
8 *
9 *      http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18/*
19 * $Id: DOM_CDATASection.hpp 568078 2007-08-21 11:43:25Z amassari $
20 */
21
22#ifndef DOM_CDataSection_HEADER_GUARD_
23#define DOM_CDataSection_HEADER_GUARD_
24
25#include <xercesc/util/XercesDefs.hpp>
26#include "DOM_Text.hpp"
27
28XERCES_CPP_NAMESPACE_BEGIN
29
30
31class CDATASectionImpl;
32
33/**
34 * <code>DOM_CDataSection</code> objects refer to the data from an
35 * XML CDATA section.  These are used to escape blocks of text containing  characters
36 * that would otherwise be regarded as markup.
37 *
38 * <p>Note that the string data associated with the CDATA section may
39 * contain characters that need to be escaped when appearing in an
40 * XML document outside of a CDATA section.
41 * <p> The <code>DOM_CDATASection</code> class inherits from the
42 * <code>DOM_CharacterData</code> class through the <code>Text</code>
43 * interface. Adjacent CDATASection nodes are not merged by use
44 * of the Element.normalize() method.
45 */
46class DEPRECATED_DOM_EXPORT DOM_CDATASection: public DOM_Text {
47public:
48  /** @name Constructors and assignment operators */
49  //@{
50  /**
51    * Default constructor for DOM_CDATASection.  The resulting object does not
52    * refer to any actual CData section; it will compare == to 0, and is similar
53    * to a null object reference variable in Java.
54    *
55    */
56        DOM_CDATASection();
57  /**
58    * Copy constructor.  Creates a new <code>DOM_CDataSection</code> that refers to the
59    *   same underlying data as the original.  See also <code>DOM_Node::clone()</code>,
60    * which will copy the underlying data, rather than just creating a new
61    * reference to the original object.
62    *
63    * @param other The source <code>DOM_CDATASection</code> object
64    */
65        DOM_CDATASection(const DOM_CDATASection &other);
66
67  /**
68    * Assignment operator.
69    *
70    * @param other The object to be copied.
71    */
72        DOM_CDATASection & operator = (const DOM_CDATASection &other);
73
74    /**
75      * Assignment operator.  This overloaded variant is provided for
76      *   the sole purpose of setting a DOM_Node reference variable to
77      *   zero.  Nulling out a reference variable in this way will decrement
78      *   the reference count on the underlying Node object that the variable
79      *   formerly referenced.  This effect is normally obtained when reference
80      *   variable goes out of scope, but zeroing them can be useful for
81      *   global instances, or for local instances that will remain in scope
82      *   for an extended time,  when the storage belonging to the underlying
83      *   node needs to be reclaimed.
84      *
85      * @param val   Only a value of 0, or null, is allowed.
86      */
87    DOM_CDATASection & operator = (const DOM_NullPtr *val);
88
89
90    //@}
91    /** @name Destructor. */
92    //@{
93         /**
94          * Destructor for DOM_CDATASection.
95          *
96          */
97
98            ~DOM_CDATASection();
99    //@}
100
101
102protected:
103        DOM_CDATASection(CDATASectionImpl *);
104
105    friend class DOM_Document;
106
107};
108
109XERCES_CPP_NAMESPACE_END
110
111#endif
112
113
Note: See TracBrowser for help on using the repository browser.