xercesc/dom/DOMDocumentRange.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_DOMDOCUMENTRANGE_HPP)
0023 #define XERCESC_INCLUDE_GUARD_DOMDOCUMENTRANGE_HPP
0024
0025 #include <xercesc/util/XercesDefs.hpp>
0026
0027 XERCES_CPP_NAMESPACE_BEGIN
0028
0029
0030 class DOMRange;
0031
0032
0033 /**
0034  * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Traversal-Range-20001113'>Document Object Model (DOM) Level 2 Traversal and Range Specification</a>.
0035  * @since DOM Level 2
0036  */
0037 class CDOM_EXPORT DOMDocumentRange {
0038
0039 protected:
0040     // -----------------------------------------------------------------------
0041     //  Hidden constructors
0042     // -----------------------------------------------------------------------
0043     /** @name Hidden constructors */
0044     //@{
0045     DOMDocumentRange() {};
0046     //@}
0047
0048 private:
0049     // -----------------------------------------------------------------------
0050     // Unimplemented constructors and operators
0051     // -----------------------------------------------------------------------
0052     /** @name Unimplemented constructors and operators */
0053     //@{
0054     DOMDocumentRange(const DOMDocumentRange &);
0055     DOMDocumentRange & operator = (const DOMDocumentRange &);
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 ~DOMDocumentRange() {};
0069     //@}
0070
0071     // -----------------------------------------------------------------------
0072     //  Virtual DOMDocumentRange interface
0073     // -----------------------------------------------------------------------
0074     /** @name Functions introduced in DOM Level 2 */
0075     //@{
0076     /**
0077       * To create the range  consisting of boundary-points and offset of the
0078      * selected contents
0079      *
0080      * @return The initial state of the Range such that both the boundary-points
0081      * are positioned at the beginning of the corresponding DOMDOcument, before
0082      * any content. The range returned can only be used to select content
0083      * associated with this document, or with documentFragments and Attrs for
0084      * which this document is the ownerdocument
0085      * @since DOM Level 2
0086       */
0087     virtual DOMRange    *createRange() = 0;
0088
0089     //@}
0090 };
0091
0092
0093 XERCES_CPP_NAMESPACE_END
0094
0095 #endif