DOM_ProcessingInstruction.hpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:7k
源码类别:

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  * 
  4.  * Copyright (c) 1999-2000 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.  * $Log: DOM_ProcessingInstruction.hpp,v $
  58.  * Revision 1.5  2000/03/02 19:53:57  roddey
  59.  * This checkin includes many changes done while waiting for the
  60.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  61.  * available elsewhere.
  62.  *
  63.  * Revision 1.4  2000/02/24 20:11:28  abagchi
  64.  * Swat for removing Log from API docs
  65.  *
  66.  * Revision 1.3  2000/02/06 07:47:31  rahulj
  67.  * Year 2K copyright swat.
  68.  *
  69.  * Revision 1.2  2000/01/05 01:16:08  andyh
  70.  * DOM Level 2 core, namespace support added.
  71.  *
  72.  * Revision 1.1.1.1  1999/11/09 01:09:03  twl
  73.  * Initial checkin
  74.  *
  75.  * Revision 1.2  1999/11/08 20:44:21  rahul
  76.  * Swat for adding in Product name and CVS comment log variable.
  77.  *
  78.  */
  79. #ifndef DOM_ProcessingInstruction_HEADER_GUARD_
  80. #define DOM_ProcessingInstruction_HEADER_GUARD_
  81. #include <util/XercesDefs.hpp>
  82. #include <dom/DOM_Node.hpp>
  83. class ProcessingInstructionImpl;
  84. /**
  85.  * The <code>ProcessingInstruction</code> interface represents a  "processing 
  86.  * instruction", used in XML as a way to keep processor-specific information 
  87.  * in the text of the document.
  88.  */
  89. class  CDOM_EXPORT DOM_ProcessingInstruction: public DOM_Node {
  90. public:
  91.     /** @name Constructors and assignment operator */
  92.     //@{
  93.     /**
  94.       * Default constructor for DOM_ProcessingInstruction.  The resulting object
  95.       *  does not refer to an actual PI node; it will compare == to 0, and is similar
  96.       * to a null object reference variable in Java.  It may subsequently be
  97.       * assigned to refer to an actual PI node.
  98.       * <p>
  99.       * New Processing Instruction nodes are created by DOM_Document::createProcessingInstruction().
  100.       *
  101.       *
  102.       */
  103.     DOM_ProcessingInstruction();
  104.     /**
  105.       * Copy constructor.  Creates a new <code>DOM_ProcessingInstruction</code> that refers to the
  106.       * same underlying node as the original.  See also DOM_Node::clone(),
  107.       * which will copy the actual PI node, rather than just creating a new
  108.       * reference to the original node.
  109.       *
  110.       * @param other The object to be copied.
  111.       */
  112.     DOM_ProcessingInstruction(const DOM_ProcessingInstruction &other);
  113.     /**
  114.       * Assignment operator.
  115.       *
  116.       * @param other The object to be copied.
  117.       */
  118.     DOM_ProcessingInstruction & operator = (const DOM_ProcessingInstruction &other);
  119.     /**
  120.       * Assignment operator.  This overloaded variant is provided for
  121.       *   the sole purpose of setting a DOM_Node reference variable to
  122.       *   zero.  Nulling out a reference variable in this way will decrement
  123.       *   the reference count on the underlying Node object that the variable
  124.       *   formerly referenced.  This effect is normally obtained when reference
  125.       *   variable goes out of scope, but zeroing them can be useful for
  126.       *   global instances, or for local instances that will remain in scope
  127.       *   for an extended time,  when the storage belonging to the underlying
  128.       *   node needs to be reclaimed.
  129.       *
  130.       * @param val.  Only a value of 0, or null, is allowed.
  131.       */
  132.     DOM_ProcessingInstruction & operator = (const DOM_NullPtr *val);
  133.     //@}
  134.     /** @name Destructor. */
  135.     //@{
  136.  /**
  137.   * Destructor for DOM_processingInstruction.  The object being destroyed is the reference
  138.       * object, not the underlying PI node itself.
  139.   *
  140.   */
  141.     ~DOM_ProcessingInstruction();
  142.     //@}
  143.     /** @name Get functions. */
  144.     //@{
  145.     /**
  146.      * The target of this processing instruction. 
  147.      *
  148.      * XML defines this as being the 
  149.      * first token following the markup that begins the processing instruction.
  150.      */
  151.     DOMString        getTarget() const;
  152.     /**
  153.      * The content of this processing instruction. 
  154.      *
  155.      * This is from the first non 
  156.      * white space character after the target to the character immediately 
  157.      * preceding the <code>?&gt;</code>.
  158.      * @exception DOMException
  159.      *   NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
  160.      */
  161.     DOMString        getData() const;
  162.     //@}
  163.     /** @name Set functions. */
  164.     //@{
  165.     /**
  166.     * Sets the content of this processing instruction. 
  167.     *
  168.     * This is from the first non 
  169.     * white space character after the target to the character immediately 
  170.     * preceding the <code>?&gt;</code>.
  171.     * @param data The string containing the processing instruction
  172.     */
  173.     void             setData(const DOMString &data);
  174.     //@}
  175. protected:
  176.     DOM_ProcessingInstruction(ProcessingInstructionImpl *impl);
  177.     friend class DOM_Document;
  178. };
  179. #endif