source: icXML/icXML-devel/src/xercesc/dom/DOMProcessingInstruction.hpp @ 2722

Last change on this file since 2722 was 2722, checked in by cameron, 6 years ago

Original Xerces files with import mods for icxercesc

File size: 4.2 KB
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: DOMProcessingInstruction.hpp 527149 2007-04-10 14:56:39Z amassari $
20 */
21
22#if !defined(XERCESC_INCLUDE_GUARD_DOMPROCESSINGINSTRUCTION_HPP)
23#define XERCESC_INCLUDE_GUARD_DOMPROCESSINGINSTRUCTION_HPP
24
25#include <xercesc/util/XercesDefs.hpp>
26#include <xercesc/dom/DOMNode.hpp>
27
28XERCES_CPP_NAMESPACE_BEGIN
29
30
31/**
32 * The <code>DOMProcessingInstruction</code> interface represents a  "processing
33 * instruction", used in XML as a way to keep processor-specific information
34 * in the text of the document.
35 *
36 * @since DOM Level 1
37 */
38class  CDOM_EXPORT DOMProcessingInstruction: public DOMNode {
39protected:
40    // -----------------------------------------------------------------------
41    //  Hidden constructors
42    // -----------------------------------------------------------------------
43    /** @name Hidden constructors */
44    //@{   
45    DOMProcessingInstruction() {}
46    DOMProcessingInstruction(const DOMProcessingInstruction &other) : DOMNode(other) {}
47    //@}
48
49private:
50    // -----------------------------------------------------------------------
51    // Unimplemented constructors and operators
52    // -----------------------------------------------------------------------
53    /** @name Unimplemented operators */
54    //@{
55    DOMProcessingInstruction & operator = (const DOMProcessingInstruction &);
56    //@}
57
58public:
59    // -----------------------------------------------------------------------
60    //  All constructors are hidden, just the destructor is available
61    // -----------------------------------------------------------------------
62    /** @name Destructor */
63    //@{
64    /**
65     * Destructor
66     *
67     */
68    virtual ~DOMProcessingInstruction() {};
69    //@}
70
71    // -----------------------------------------------------------------------
72    //  Virtual DOMProcessingInstruction interface
73    // -----------------------------------------------------------------------
74    /** @name Functions introduced in DOM Level 1 */
75    //@{
76    // -----------------------------------------------------------------------
77    //  Getter methods
78    // -----------------------------------------------------------------------
79    /**
80     * The target of this processing instruction.
81     *
82     * XML defines this as being the
83     * first token following the markup that begins the processing instruction.
84     *
85     * @since DOM Level 1
86     */
87    virtual const XMLCh *        getTarget() const = 0;
88
89    /**
90     * The content of this processing instruction.
91     *
92     * This is from the first non
93     * white space character after the target to the character immediately
94     * preceding the <code>?&gt;</code>.
95     * @exception DOMException
96     *   NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
97     * @since DOM Level 1
98     */
99    virtual const XMLCh *        getData() const = 0;
100
101    // -----------------------------------------------------------------------
102    //  Setter methods
103    // -----------------------------------------------------------------------
104    /**
105     * Sets the content of this processing instruction.
106     *
107     * This is from the first non
108     * white space character after the target to the character immediately
109     * preceding the <code>?&gt;</code>.
110     * @param data The string containing the processing instruction
111     * @since DOM Level 1
112     */
113    virtual void             setData(const XMLCh * data) = 0;
114    //@}
115
116};
117
118XERCES_CPP_NAMESPACE_END
119
120#endif
121
Note: See TracBrowser for help on using the repository browser.