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

Revision 188, 6.4 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_Notation.hpp,v 1.3 2002/11/04 15:04:44 tng Exp $
59 */
60
61#ifndef DOM_Notation_HEADER_GUARD_
62#define DOM_Notation_HEADER_GUARD_
63
64#include <xercesc/util/XercesDefs.hpp>
65#include "DOM_Node.hpp"
66
67XERCES_CPP_NAMESPACE_BEGIN
68
69
70class NotationImpl;
71
72/**
73 * This interface represents a notation declared in the DTD. A notation either
74 * declares, by name, the format of an unparsed entity (see section 4.7 of
75 * the XML 1.0 specification), or is used for formal declaration of
76 * Processing Instruction targets (see section 2.6 of the XML 1.0
77 * specification). The <code>nodeName</code> attribute inherited from
78 * <code>Node</code> is set to the declared name of the notation.
79 * <p>The DOM Level 1 does not support editing <code>Notation</code> nodes;
80 * they are therefore readonly.
81 * <p>A <code>Notation</code> node does not have any parent.
82 */
83class CDOM_EXPORT DOM_Notation: public DOM_Node {
84public:
85    /** @name Constructors and assignment operator */
86    //@{
87    /**
88      * Default constructor for DOM_Notation.  The resulting object does not
89    * refer to an actual Notation node; it will compare == to 0, and is similar
90    * to a null object reference variable in Java.  It may subsequently be
91    * assigned to refer to an actual Notation node.
92    * <p>
93    * New notation nodes are created by DOM_Document::createNotation().
94    *
95      *
96      */
97    DOM_Notation();
98
99    /**
100      * Copy constructor.  Creates a new <code>DOM_Notation</code> that refers to the
101      * same underlying node as the original.  See also DOM_Node::clone(),
102      * which will copy the actual notation node, rather than just creating a new
103      * reference to the original node.
104      *
105      * @param other The object to be copied.
106      */
107    DOM_Notation(const DOM_Notation &other);
108
109    /**
110      * Assignment operator.
111      *
112      * @param other The object to be copied.
113      */
114    DOM_Notation & operator = (const DOM_Notation &other);
115
116     /**
117      * Assignment operator.  This overloaded variant is provided for
118      *   the sole purpose of setting a DOM_Node reference variable to
119      *   zero.  Nulling out a reference variable in this way will decrement
120      *   the reference count on the underlying Node object that the variable
121      *   formerly referenced.  This effect is normally obtained when reference
122      *   variable goes out of scope, but zeroing them can be useful for
123      *   global instances, or for local instances that will remain in scope
124      *   for an extended time,  when the storage belonging to the underlying
125      *   node needs to be reclaimed.
126      *
127      * @param val   Only a value of 0, or null, is allowed.
128      */
129    DOM_Notation & operator = (const DOM_NullPtr *val);
130
131
132    //@}
133    /** @name Destructor. */
134    //@{
135         /**
136          * Destructor for DOM_Notation.  The object being destroyed is the reference
137      * object, not the underlying Notation node itself.
138      *
139          */
140    ~DOM_Notation();
141
142    //@}
143    /** @name Get functions. */
144    //@{
145
146    /**
147     * Get the public identifier of this notation.
148     *
149     * If the  public identifier was not
150     * specified, this is <code>null</code>.
151     * @return Returns the public identifier of the notation
152     */
153    DOMString        getPublicId() const;
154    /**
155     * Get the system identifier of this notation.
156     *
157     * If the  system identifier was not
158     * specified, this is <code>null</code>.
159     * @return Returns the system identifier of the notation
160     */
161    DOMString        getSystemId() const;
162
163
164    //@}
165
166protected:
167    DOM_Notation(NotationImpl *impl);
168
169    friend class DOM_Document;
170
171};
172
173XERCES_CPP_NAMESPACE_END
174
175#endif
176
177
Note: See TracBrowser for help on using the repository browser.