| API Docs for SAX and DOM |

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

# DOMRange.hpp

Go to the documentation of this file.

    00001 #ifndef DOMRange_HEADER_GUARD_
    00002 #define DOMRange_HEADER_GUARD_
    00003
    00004 /*
    00005  * The Apache Software License, Version 1.1
    00006  *
    00007  * Copyright (c) 2001-2002 The Apache Software Foundation.  All rights
    00008  * reserved.
    00009  *
    00010  * Redistribution and use in source and binary forms, with or without
    00011  * modification, are permitted provided that the following conditions
    00012  * are met:
    00013  *
    00014  * 1. Redistributions of source code must retain the above copyright
    00015  *    notice, this list of conditions and the following disclaimer.
    00016  *
    00017  * 2. Redistributions in binary form must reproduce the above copyright
    00018  *    notice, this list of conditions and the following disclaimer in
    00019  *    the documentation and/or other materials provided with the
    00020  *    distribution.
    00021  *
    00022  * 3. The end-user documentation included with the redistribution,
    00023  *    if any, must include the following acknowledgment:
    00024  *       "This product includes software developed by the
    00025  *        Apache Software Foundation (http://www.apache.org/)."
    00026  *    Alternately, this acknowledgment may appear in the software itself,
    00027  *    if and wherever such third-party acknowledgments normally appear.
    00028  *
    00029  * 4. The names "Xerces" and "Apache Software Foundation" must
    00030  *    not be used to endorse or promote products derived from this
    00031  *    software without prior written permission. For written
    00032  *    permission, please contact apache\@apache.org.
    00033  *
    00034  * 5. Products derived from this software may not be called "Apache",
    00035  *    nor may "Apache" appear in their name, without prior written
    00036  *    permission of the Apache Software Foundation.
    00037  *
    00038  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
    00039  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    00040  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    00041  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
    00042  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    00043  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    00044  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
    00045  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    00046  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    00047  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
    00048  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    00049  * SUCH DAMAGE.
    00050  * ====================================================================
    00051  *
    00052  * This software consists of voluntary contributions made by many
    00053  * individuals on behalf of the Apache Software Foundation, and was
    00054  * originally based on software copyright (c) 2001, International
    00055  * Business Machines, Inc., http://www.ibm.com .  For more information
    00056  * on the Apache Software Foundation, please see
    00057  * <http://www.apache.org/>.
    00058  */
    00059
    00060 /*
    00061  * $Id: DOMRange.hpp,v 1.6 2002/08/22 15:04:57 tng Exp $
    00062  */
    00063
    00064 #include <xercesc/util/XercesDefs.hpp>
    00065
    00066 class DOMNode;
    00067 class DOMDocumentFragment;
    00068
    00073 class  DOMRange {
    00074 protected:
    00075     // -----------------------------------------------------------------------
    00076     //  Hidden constructors
    00077     // -----------------------------------------------------------------------
    00080     DOMRange() {};
    00081     DOMRange(const DOMRange &) {};
    00082     DOMRange & operator = (const DOMRange &) {return *this;};
    00084
    00085 public:
    00086     // -----------------------------------------------------------------------
    00087     //  All constructors are hidden, just the destructor is available
    00088     // -----------------------------------------------------------------------
    00091
    00095     virtual ~DOMRange() {};
    00097
    00098     // -----------------------------------------------------------------------
    00099     //  Class Types
    00100     // -----------------------------------------------------------------------
    00103
    00128     enum CompareHow {
    00129         START_TO_START  = 0,
    00130         START_TO_END    = 1,
    00131         END_TO_END      = 2,
    00132         END_TO_START    = 3
    00133     };
    00134
    00136
    00137     // -----------------------------------------------------------------------
    00138     //  Virtual DOMRange interface
    00139     // -----------------------------------------------------------------------
    00142     // -----------------------------------------------------------------------
    00143     //  Getter methods
    00144     // -----------------------------------------------------------------------
    00153     virtual DOMNode* getStartContainer() const = 0;
    00154
    00163     virtual XMLSize_t getStartOffset() const = 0;
    00164
    00173     virtual DOMNode* getEndContainer() const = 0;
    00174
    00183     virtual XMLSize_t getEndOffset() const = 0;
    00184
    00193     virtual bool getCollapsed() const = 0;
    00194
    00204     virtual const DOMNode* getCommonAncestorContainer() const = 0;
    00205
    00206     // -----------------------------------------------------------------------
    00207     //  Setter methods
    00208     // -----------------------------------------------------------------------
    00231     virtual void setStart(const DOMNode *refNode, XMLSize_t offset) = 0;
    00232
    00255     virtual void setEnd(const DOMNode *refNode, XMLSize_t offset) = 0;
    00256
    00273     virtual void setStartBefore(const DOMNode *refNode) = 0;
    00274
    00291     virtual void setStartAfter(const DOMNode *refNode) = 0;
    00292
    00309     virtual void setEndBefore(const DOMNode *refNode) = 0;
    00310
    00327     virtual void setEndAfter(const DOMNode *refNode) = 0;
    00328
    00329     // -----------------------------------------------------------------------
    00330     //  Misc methods
    00331     // -----------------------------------------------------------------------
    00342     virtual void collapse(bool toStart) = 0;
    00343
    00360     virtual void selectNode(const DOMNode *refNode) = 0;
    00361
    00376     virtual void selectNodeContents(const DOMNode *refNode) = 0;
    00377
    00395     virtual short compareBoundaryPoints(CompareHow how, const DOMRange* sourceRange) const = 0;
    00396
    00410     virtual void deleteContents() = 0;
    00411
    00427     virtual DOMDocumentFragment* extractContents() = 0;
    00428
    00441     virtual DOMDocumentFragment* cloneContents() const = 0;
    00442
    00471     virtual void insertNode(DOMNode *newNode) = 0;
    00472
    00498     virtual void surroundContents(DOMNode *newParent) = 0;
    00499
    00510     virtual DOMRange* cloneRange() const = 0;
    00511
    00522     virtual const XMLCh* toString() const = 0;
    00523
    00536     virtual void detach() = 0;
    00537
    00539
    00540     // -----------------------------------------------------------------------
    00541     //  Non-standard Extension
    00542     // -----------------------------------------------------------------------
    00545
    00552     virtual void release() = 0;
    00554 };
    00555
    00556
    00557 #endif

Copyright © 2000 The Apache Software Foundation. All Rights Reserved.