DOMUserDataHandler.hpp
上传用户:zhuqijet
上传日期:2013-06-25
资源大小:10074k
文件大小:7k
源码类别:

词法分析

开发平台:

Visual C++

  1. #ifndef DOMUserDataHandler_HEADER_GUARD_
  2. #define DOMUserDataHandler_HEADER_GUARD_
  3. /*
  4.  * The Apache Software License, Version 1.1
  5.  *
  6.  * Copyright (c) 2002 The Apache Software Foundation.  All rights
  7.  * reserved.
  8.  *
  9.  * Redistribution and use in source and binary forms, with or without
  10.  * modification, are permitted provided that the following conditions
  11.  * are met:
  12.  *
  13.  * 1. Redistributions of source code must retain the above copyright
  14.  *    notice, this list of conditions and the following disclaimer.
  15.  *
  16.  * 2. Redistributions in binary form must reproduce the above copyright
  17.  *    notice, this list of conditions and the following disclaimer in
  18.  *    the documentation and/or other materials provided with the
  19.  *    distribution.
  20.  *
  21.  * 3. The end-user documentation included with the redistribution,
  22.  *    if any, must include the following acknowledgment:
  23.  *       "This product includes software developed by the
  24.  *        Apache Software Foundation (http://www.apache.org/)."
  25.  *    Alternately, this acknowledgment may appear in the software itself,
  26.  *    if and wherever such third-party acknowledgments normally appear.
  27.  *
  28.  * 4. The names "Xerces" and "Apache Software Foundation" must
  29.  *    not be used to endorse or promote products derived from this
  30.  *    software without prior written permission. For written
  31.  *    permission, please contact apache@apache.org.
  32.  *
  33.  * 5. Products derived from this software may not be called "Apache",
  34.  *    nor may "Apache" appear in their name, without prior written
  35.  *    permission of the Apache Software Foundation.
  36.  *
  37.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  38.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  39.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  40.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  41.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  42.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  43.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  44.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  45.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  46.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  47.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  48.  * SUCH DAMAGE.
  49.  * ====================================================================
  50.  *
  51.  * This software consists of voluntary contributions made by many
  52.  * individuals on behalf of the Apache Software Foundation, and was
  53.  * originally based on software copyright (c) 1999, International
  54.  * Business Machines, Inc., http://www.ibm.com .  For more information
  55.  * on the Apache Software Foundation, please see
  56.  * <http://www.apache.org/>.
  57.  */
  58. /*
  59.  * $Id: DOMUserDataHandler.hpp,v 1.6 2003/03/07 19:59:09 tng Exp $
  60.  */
  61. #include <xercesc/util/XercesDefs.hpp>
  62. #include <xercesc/dom/DOMNode.hpp>
  63. XERCES_CPP_NAMESPACE_BEGIN
  64. /**
  65.  * When associating an object to a key on a node using <code>setUserData</code>
  66.  *  the application can provide a handler that gets called when the node the
  67.  * object is associated to is being cloned or imported. This can be used by
  68.  * the application to implement various behaviors regarding the data it
  69.  * associates to the DOM nodes. This interface defines that handler.
  70.  *
  71.  * <p><b>"Experimental - subject to change"</b></p>
  72.  *
  73.  * <p>See also the <a href='http://www.w3.org/2001/07/WD-DOM-Level-3-Core-20010726'>Document Object Model (DOM) Level 3 Core Specification</a>.
  74.  * @since DOM Level 3
  75.  */
  76. class CDOM_EXPORT DOMUserDataHandler {
  77. protected:
  78.     // -----------------------------------------------------------------------
  79.     //  Hidden constructors
  80.     // -----------------------------------------------------------------------
  81.     /** @name Hidden constructors */
  82.     //@{    
  83.     DOMUserDataHandler() {};
  84.     //@}
  85. private:
  86.     // -----------------------------------------------------------------------
  87.     // Unimplemented constructors and operators
  88.     // -----------------------------------------------------------------------
  89.     /** @name Unimplemented constructors and operators */
  90.     //@{
  91.     DOMUserDataHandler(const DOMUserDataHandler &);
  92.     DOMUserDataHandler & operator = (const DOMUserDataHandler &);
  93.     //@}
  94. public:
  95.     // -----------------------------------------------------------------------
  96.     //  All constructors are hidden, just the destructor is available
  97.     // -----------------------------------------------------------------------
  98.     /** @name Destructor */
  99.     //@{
  100.     /**
  101.      * Destructor
  102.      *
  103.      */
  104.     virtual ~DOMUserDataHandler() {};
  105.     //@}
  106.     // -----------------------------------------------------------------------
  107.     //  Class Types
  108.     // -----------------------------------------------------------------------
  109.     /** @name Public Constants */
  110.     //@{
  111.     /**
  112.      * Operation Type
  113.      *
  114.      * <p><code>NODE_CLONED:</code>
  115.      * The node is cloned.</p>
  116.      *
  117.      * <p><code>NODE_IMPORTED</code>
  118.      * The node is imported.</p>
  119.      *
  120.      * <p><code>NODE_DELETED</code>
  121.      * The node is deleted.</p>
  122.      *
  123.      * <p><code>NODE_RENAMED</code>
  124.      * The node is renamed.
  125.      *
  126.      * <p><b>"Experimental - subject to change"</b></p>
  127.      *
  128.      * @since DOM Level 3
  129.      */
  130.     enum DOMOperationType {
  131.         NODE_CLONED               = 1,
  132.         NODE_IMPORTED             = 2,
  133.         NODE_DELETED              = 3,
  134.         NODE_RENAMED              = 4
  135.     };
  136.     //@}
  137.     // -----------------------------------------------------------------------
  138.     //  Virtual DOMUserDataHandler interface
  139.     // -----------------------------------------------------------------------
  140.     /** @name Functions introduced in DOM Level 3 */
  141.     //@{
  142.     /**
  143.      * This method is called whenever the node for which this handler is
  144.      * registered is imported or cloned.
  145.      *
  146.      * <p><b>"Experimental - subject to change"</b></p>
  147.      *
  148.      * @param operation Specifies the type of operation that is being
  149.      *   performed on the node.
  150.      * @param key Specifies the key for which this handler is being called.
  151.      * @param data Specifies the data for which this handler is being called.
  152.      * @param src Specifies the node being cloned, imported, or renamed.
  153.      * @param dst Specifies the node newly created.
  154.      * @since DOM Level 3
  155.      */
  156.     virtual void handle(DOMOperationType operation,
  157.                         const XMLCh* const key,
  158.                         void* data,
  159.                         const DOMNode* src,
  160.                         const DOMNode* dst) = 0;
  161.     //@}
  162. };
  163. XERCES_CPP_NAMESPACE_END
  164. #endif