[2674] | 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_Notation.hpp 568078 2007-08-21 11:43:25Z amassari $ |
---|
| 20 | */ |
---|
| 21 | |
---|
| 22 | #ifndef DOM_Notation_HEADER_GUARD_ |
---|
| 23 | #define DOM_Notation_HEADER_GUARD_ |
---|
| 24 | |
---|
| 25 | #include <xercesc/util/XercesDefs.hpp> |
---|
| 26 | #include "DOM_Node.hpp" |
---|
| 27 | |
---|
| 28 | XERCES_CPP_NAMESPACE_BEGIN |
---|
| 29 | |
---|
| 30 | |
---|
| 31 | class NotationImpl; |
---|
| 32 | |
---|
| 33 | /** |
---|
| 34 | * This interface represents a notation declared in the DTD. A notation either |
---|
| 35 | * declares, by name, the format of an unparsed entity (see section 4.7 of |
---|
| 36 | * the XML 1.0 specification), or is used for formal declaration of |
---|
| 37 | * Processing Instruction targets (see section 2.6 of the XML 1.0 |
---|
| 38 | * specification). The <code>nodeName</code> attribute inherited from |
---|
| 39 | * <code>Node</code> is set to the declared name of the notation. |
---|
| 40 | * <p>The DOM Level 1 does not support editing <code>Notation</code> nodes; |
---|
| 41 | * they are therefore readonly. |
---|
| 42 | * <p>A <code>Notation</code> node does not have any parent. |
---|
| 43 | */ |
---|
| 44 | class DEPRECATED_DOM_EXPORT DOM_Notation: public DOM_Node { |
---|
| 45 | public: |
---|
| 46 | /** @name Constructors and assignment operator */ |
---|
| 47 | //@{ |
---|
| 48 | /** |
---|
| 49 | * Default constructor for DOM_Notation. The resulting object does not |
---|
| 50 | * refer to an actual Notation node; it will compare == to 0, and is similar |
---|
| 51 | * to a null object reference variable in Java. It may subsequently be |
---|
| 52 | * assigned to refer to an actual Notation node. |
---|
| 53 | * <p> |
---|
| 54 | * New notation nodes are created by DOM_Document::createNotation(). |
---|
| 55 | * |
---|
| 56 | * |
---|
| 57 | */ |
---|
| 58 | DOM_Notation(); |
---|
| 59 | |
---|
| 60 | /** |
---|
| 61 | * Copy constructor. Creates a new <code>DOM_Notation</code> that refers to the |
---|
| 62 | * same underlying node as the original. See also DOM_Node::clone(), |
---|
| 63 | * which will copy the actual notation node, rather than just creating a new |
---|
| 64 | * reference to the original node. |
---|
| 65 | * |
---|
| 66 | * @param other The object to be copied. |
---|
| 67 | */ |
---|
| 68 | DOM_Notation(const DOM_Notation &other); |
---|
| 69 | |
---|
| 70 | /** |
---|
| 71 | * Assignment operator. |
---|
| 72 | * |
---|
| 73 | * @param other The object to be copied. |
---|
| 74 | */ |
---|
| 75 | DOM_Notation & operator = (const DOM_Notation &other); |
---|
| 76 | |
---|
| 77 | /** |
---|
| 78 | * Assignment operator. This overloaded variant is provided for |
---|
| 79 | * the sole purpose of setting a DOM_Node reference variable to |
---|
| 80 | * zero. Nulling out a reference variable in this way will decrement |
---|
| 81 | * the reference count on the underlying Node object that the variable |
---|
| 82 | * formerly referenced. This effect is normally obtained when reference |
---|
| 83 | * variable goes out of scope, but zeroing them can be useful for |
---|
| 84 | * global instances, or for local instances that will remain in scope |
---|
| 85 | * for an extended time, when the storage belonging to the underlying |
---|
| 86 | * node needs to be reclaimed. |
---|
| 87 | * |
---|
| 88 | * @param val Only a value of 0, or null, is allowed. |
---|
| 89 | */ |
---|
| 90 | DOM_Notation & operator = (const DOM_NullPtr *val); |
---|
| 91 | |
---|
| 92 | |
---|
| 93 | //@} |
---|
| 94 | /** @name Destructor. */ |
---|
| 95 | //@{ |
---|
| 96 | /** |
---|
| 97 | * Destructor for DOM_Notation. The object being destroyed is the reference |
---|
| 98 | * object, not the underlying Notation node itself. |
---|
| 99 | * |
---|
| 100 | */ |
---|
| 101 | ~DOM_Notation(); |
---|
| 102 | |
---|
| 103 | //@} |
---|
| 104 | /** @name Get functions. */ |
---|
| 105 | //@{ |
---|
| 106 | |
---|
| 107 | /** |
---|
| 108 | * Get the public identifier of this notation. |
---|
| 109 | * |
---|
| 110 | * If the public identifier was not |
---|
| 111 | * specified, this is <code>null</code>. |
---|
| 112 | * @return Returns the public identifier of the notation |
---|
| 113 | */ |
---|
| 114 | DOMString getPublicId() const; |
---|
| 115 | /** |
---|
| 116 | * Get the system identifier of this notation. |
---|
| 117 | * |
---|
| 118 | * If the system identifier was not |
---|
| 119 | * specified, this is <code>null</code>. |
---|
| 120 | * @return Returns the system identifier of the notation |
---|
| 121 | */ |
---|
| 122 | DOMString getSystemId() const; |
---|
| 123 | |
---|
| 124 | |
---|
| 125 | //@} |
---|
| 126 | |
---|
| 127 | protected: |
---|
| 128 | DOM_Notation(NotationImpl *impl); |
---|
| 129 | |
---|
| 130 | friend class DOM_Document; |
---|
| 131 | |
---|
| 132 | }; |
---|
| 133 | |
---|
| 134 | XERCES_CPP_NAMESPACE_END |
---|
| 135 | |
---|
| 136 | #endif |
---|
| 137 | |
---|
| 138 | |
---|