xercesc/dom/DOMProcessingInstruction.hpp

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *      http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 /*
0019  * $Id$
0020  */
0021
0022 #if !defined(XERCESC_INCLUDE_GUARD_DOMPROCESSINGINSTRUCTION_HPP)
0023 #define XERCESC_INCLUDE_GUARD_DOMPROCESSINGINSTRUCTION_HPP
0024
0025 #include <xercesc/util/XercesDefs.hpp>
0026 #include <xercesc/dom/DOMNode.hpp>
0027
0028 XERCES_CPP_NAMESPACE_BEGIN
0029
0030
0031 /**
0032  * The <code>DOMProcessingInstruction</code> interface represents a  "processing
0033  * instruction", used in XML as a way to keep processor-specific information
0034  * in the text of the document.
0035  *
0036  * @since DOM Level 1
0037  */
0038 class  CDOM_EXPORT DOMProcessingInstruction: public DOMNode {
0039 protected:
0040     // -----------------------------------------------------------------------
0041     //  Hidden constructors
0042     // -----------------------------------------------------------------------
0043     /** @name Hidden constructors */
0044     //@{
0045     DOMProcessingInstruction() {}
0046     DOMProcessingInstruction(const DOMProcessingInstruction &other) : DOMNode(other) {}
0047     //@}
0048
0049 private:
0050     // -----------------------------------------------------------------------
0051     // Unimplemented constructors and operators
0052     // -----------------------------------------------------------------------
0053     /** @name Unimplemented operators */
0054     //@{
0055     DOMProcessingInstruction & operator = (const DOMProcessingInstruction &);
0056     //@}
0057
0058 public:
0059     // -----------------------------------------------------------------------
0060     //  All constructors are hidden, just the destructor is available
0061     // -----------------------------------------------------------------------
0062     /** @name Destructor */
0063     //@{
0064     /**
0065      * Destructor
0066      *
0067      */
0068     virtual ~DOMProcessingInstruction() {};
0069     //@}
0070
0071     // -----------------------------------------------------------------------
0072     //  Virtual DOMProcessingInstruction interface
0073     // -----------------------------------------------------------------------
0074     /** @name Functions introduced in DOM Level 1 */
0075     //@{
0076     // -----------------------------------------------------------------------
0077     //  Getter methods
0078     // -----------------------------------------------------------------------
0079     /**
0080      * The target of this processing instruction.
0081      *
0082      * XML defines this as being the
0083      * first token following the markup that begins the processing instruction.
0084      *
0085      * @since DOM Level 1
0086      */
0087     virtual const XMLCh *        getTarget() const = 0;
0088
0089     /**
0090      * The content of this processing instruction.
0091      *
0092      * This is from the first non
0093      * white space character after the target to the character immediately
0094      * preceding the <code>?&gt;</code>.
0095      * @exception DOMException
0096      *   NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
0097      * @since DOM Level 1
0098      */
0099     virtual const XMLCh *        getData() const = 0;
0100
0101     // -----------------------------------------------------------------------
0102     //  Setter methods
0103     // -----------------------------------------------------------------------
0104     /**
0105      * Sets the content of this processing instruction.
0106      *
0107      * This is from the first non
0108      * white space character after the target to the character immediately
0109      * preceding the <code>?&gt;</code>.
0110      * @param data The string containing the processing instruction
0111      * @since DOM Level 1
0112      */
0113     virtual void             setData(const XMLCh * data) = 0;
0114     //@}
0115
0116 };
0117
0118 XERCES_CPP_NAMESPACE_END
0119
0120 #endif
0121