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

Revision 188, 6.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_ProcessingInstruction.hpp,v 1.3 2002/11/04 15:04:44 tng Exp $
59 */
60
61#ifndef DOM_ProcessingInstruction_HEADER_GUARD_
62#define DOM_ProcessingInstruction_HEADER_GUARD_
63
64#include <xercesc/util/XercesDefs.hpp>
65#include "DOM_Node.hpp"
66
67XERCES_CPP_NAMESPACE_BEGIN
68
69
70class ProcessingInstructionImpl;
71
72/**
73 * The <code>ProcessingInstruction</code> interface represents a  "processing
74 * instruction", used in XML as a way to keep processor-specific information
75 * in the text of the document.
76 */
77class  CDOM_EXPORT DOM_ProcessingInstruction: public DOM_Node {
78public:
79    /** @name Constructors and assignment operator */
80    //@{
81    /**
82      * Default constructor for DOM_ProcessingInstruction.  The resulting object
83      *  does not refer to an actual PI node; it will compare == to 0, and is similar
84      * to a null object reference variable in Java.  It may subsequently be
85      * assigned to refer to an actual PI node.
86      * <p>
87      * New Processing Instruction nodes are created by DOM_Document::createProcessingInstruction().
88      *
89      *
90      */
91    DOM_ProcessingInstruction();
92
93    /**
94      * Copy constructor.  Creates a new <code>DOM_ProcessingInstruction</code> that refers to the
95      * same underlying node as the original.  See also DOM_Node::clone(),
96      * which will copy the actual PI node, rather than just creating a new
97      * reference to the original node.
98      *
99      * @param other The object to be copied.
100      */
101    DOM_ProcessingInstruction(const DOM_ProcessingInstruction &other);
102
103    /**
104      * Assignment operator.
105      *
106      * @param other The object to be copied.
107      */
108    DOM_ProcessingInstruction & operator = (const DOM_ProcessingInstruction &other);
109
110    /**
111      * Assignment operator.  This overloaded variant is provided for
112      *   the sole purpose of setting a DOM_Node reference variable to
113      *   zero.  Nulling out a reference variable in this way will decrement
114      *   the reference count on the underlying Node object that the variable
115      *   formerly referenced.  This effect is normally obtained when reference
116      *   variable goes out of scope, but zeroing them can be useful for
117      *   global instances, or for local instances that will remain in scope
118      *   for an extended time,  when the storage belonging to the underlying
119      *   node needs to be reclaimed.
120      *
121      * @param val   Only a value of 0, or null, is allowed.
122      */
123    DOM_ProcessingInstruction & operator = (const DOM_NullPtr *val);
124
125    //@}
126    /** @name Destructor. */
127    //@{
128         /**
129          * Destructor for DOM_processingInstruction.  The object being destroyed is the reference
130      * object, not the underlying PI node itself.
131          *
132          */
133    ~DOM_ProcessingInstruction();
134
135    //@}
136    /** @name Get functions. */
137    //@{
138    /**
139     * The target of this processing instruction.
140     *
141     * XML defines this as being the
142     * first token following the markup that begins the processing instruction.
143     */
144    DOMString        getTarget() const;
145
146    /**
147     * The content of this processing instruction.
148     *
149     * This is from the first non
150     * white space character after the target to the character immediately
151     * preceding the <code>?&gt;</code>.
152     * @exception DOMException
153     *   NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
154     */
155    DOMString        getData() const;
156
157    //@}
158    /** @name Set functions. */
159    //@{
160    /**
161    * Sets the content of this processing instruction.
162    *
163    * This is from the first non
164    * white space character after the target to the character immediately
165    * preceding the <code>?&gt;</code>.
166    * @param data The string containing the processing instruction
167    */
168    void             setData(const DOMString &data);
169    //@}
170
171protected:
172    DOM_ProcessingInstruction(ProcessingInstructionImpl *impl);
173
174    friend class DOM_Document;
175
176};
177
178XERCES_CPP_NAMESPACE_END
179
180#endif
181
Note: See TracBrowser for help on using the repository browser.