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

Revision 188, 7.6 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_Attr.hpp,v 1.3 2002/11/04 15:04:44 tng Exp $
59 */
60
61#ifndef DOM_Attr_HEADER_GUARD_
62#define DOM_Attr_HEADER_GUARD_
63
64#include <xercesc/util/XercesDefs.hpp>
65#include "DOM_Node.hpp"
66#include "DOM_Element.hpp"
67
68XERCES_CPP_NAMESPACE_BEGIN
69
70
71class AttrImpl;
72
73/**
74* The <code>DOM_Attr</code> class refers to an attribute of an XML element.
75*
76* Typically the allowable values for the
77* attribute are defined in a documenttype definition.
78* <p><code>DOM_Attr</code> objects inherit the <code>DOM_Node</code>  interface, but
79* since attributes are not actually child nodes of the elements they are associated with, the
80* DOM does not consider them part of the document  tree.  Thus, the
81* <code>DOM_Node</code> attributes <code>parentNode</code>,
82* <code>previousSibling</code>, and <code>nextSibling</code> have a  null
83* value for <code>DOM_Attr</code> objects. The DOM takes the  view that
84* attributes are properties of elements rather than having a  separate
85* identity from the elements they are associated with;  this should make it
86* more efficient to implement such features as default attributes associated
87* with all elements of a  given type.  Furthermore, attribute nodes
88* may not be immediate children of a <code>DocumentFragment</code>. However,
89* they can be associated with <code>Element</code> nodes contained within a
90* <code>DocumentFragment</code>. In short, users of the DOM
91* need to be aware that  <code>Attr</code> nodes have some things in  common
92* with other objects inheriting the <code>Node</code> interface, but they
93* also are quite distinct.
94*
95*/
96class CDOM_EXPORT DOM_Attr: public DOM_Node {
97
98public:
99  /** @name Constructors and assignment operators */
100  //@{
101  /**
102    * Default constructor for DOM_Attr.  The resulting object does not
103    * refer to any Attribute; it will compare == to 0, and is similar
104    * to a null object reference variable in Java.
105    *
106    */
107    DOM_Attr();
108
109public:
110
111  /**
112    * Copy constructor.  Creates a new <code>DOM_Attr</code> that refers to the
113    *   same underlying Attribute as the original.  See also DOM_Node::clone(),
114    * which will copy an actual attribute, rather than just creating a new
115    * reference to the original attribute.
116    *
117    * @param other The source attribute reference object
118    */
119    DOM_Attr(const DOM_Attr &other);
120
121  /**
122    * Assignment operator
123    *
124    * @param other The source attribute object
125    */
126    DOM_Attr & operator = (const DOM_Attr &other);
127
128    /**
129      * Assignment operator.  This overloaded variant is provided for
130      *   the sole purpose of setting a DOM_Node reference variable to
131      *   zero.  Nulling out a reference variable in this way will decrement
132      *   the reference count on the underlying Node object that the variable
133      *   formerly referenced.  This effect is normally obtained when reference
134      *   variable goes out of scope, but zeroing them can be useful for
135      *   global instances, or for local instances that will remain in scope
136      *   for an extended time,  when the storage belonging to the underlying
137      *   node needs to be reclaimed.
138      *
139      * @param val   Only a value of 0, or null, is allowed.
140      */
141    DOM_Attr & operator = (const DOM_NullPtr *val);
142
143
144
145        //@}
146  /** @name Destructor */
147  //@{
148       
149  /**
150    * Destructor.  The object being destroyed is a reference to the Attribute
151    * "node", not the underlying attribute itself.
152    *
153    */
154    ~DOM_Attr();
155        //@}
156
157  /** @name Getter functions */
158  //@{
159    /**
160    * Returns the name of this attribute.
161    */
162    DOMString       getName() const;
163
164    /**
165    *
166    * Returns true if the attribute received its value explicitly in the
167    * XML document, or if a value was assigned programatically with
168    * the setValue function.  Returns false if the attribute value
169    * came from the default value declared in the document's DTD.
170    */
171    bool            getSpecified() const;
172
173    /**
174        * Returns the value of the attribute.
175        *
176    * The value of the attribute is returned as a string.
177    * Character and general entity references are replaced with their values.
178    */
179    DOMString       getValue() const;
180
181        //@}
182  /** @name Setter functions */
183  //@{
184    /**
185        * Sets the value of the attribute.  A text node with the unparsed contents
186    * of the string will be created.
187        *
188    * @param value The value of the DOM attribute to be set
189    */
190    void            setValue(const DOMString &value);
191        //@}
192
193    /** @name Functions introduced in DOM Level 2. */
194    //@{
195    /**
196     * The <code>DOM_Element</code> node this attribute is attached to or
197     * <code>null</code> if this attribute is not in use.
198     *
199     */
200    DOM_Element     getOwnerElement() const;
201    //@}
202
203protected:
204    DOM_Attr(AttrImpl *attr);
205
206    friend class DOM_Element;
207    friend class DOM_Document;
208
209};
210
211XERCES_CPP_NAMESPACE_END
212
213#endif
214
215
Note: See TracBrowser for help on using the repository browser.