API Docs for SAX and DOM                 DOMRange.hpp Go to the documentation of this file. #ifndef DOMRange_HEADER_GUARD_ #define DOMRange_HEADER_GUARD_ /* * The Apache Software License, Version 1.1 * * Copyright (c) 2001-2002 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Xerces" and "Apache Software Foundation" must * not be used to endorse or promote products derived from this * software without prior written permission. For written * permission, please contact apache\@apache.org. * * 5. Products derived from this software may not be called "Apache", * nor may "Apache" appear in their name, without prior written * permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation, and was * originally based on software copyright (c) 2001, International * Business Machines, Inc., http://www.ibm.com . For more information * on the Apache Software Foundation, please see * <http://www.apache.org/>. */ /* * $Id: DOMRange.hpp,v 1.7 2002/11/04 15:09:24 tng Exp $ */ #include <xercesc/util/XercesDefs.hpp> XERCES_CPP_NAMESPACE_BEGIN class DOMNode; class DOMDocumentFragment; class DOMRange { protected: // ----------------------------------------------------------------------- // Hidden constructors // ----------------------------------------------------------------------- DOMRange() {}; DOMRange(const DOMRange &) {}; DOMRange & operator = (const DOMRange &) {return *this;}; public: // ----------------------------------------------------------------------- // All constructors are hidden, just the destructor is available // ----------------------------------------------------------------------- virtual ~DOMRange() {}; // ----------------------------------------------------------------------- // Class Types // ----------------------------------------------------------------------- enum CompareHow { START_TO_START = 0, START_TO_END = 1, END_TO_END = 2, END_TO_START = 3 }; // ----------------------------------------------------------------------- // Virtual DOMRange interface // ----------------------------------------------------------------------- // ----------------------------------------------------------------------- // Getter methods // ----------------------------------------------------------------------- virtual DOMNode* getStartContainer() const = 0; virtual XMLSize_t getStartOffset() const = 0; virtual DOMNode* getEndContainer() const = 0; virtual XMLSize_t getEndOffset() const = 0; virtual bool getCollapsed() const = 0; virtual const DOMNode* getCommonAncestorContainer() const = 0; // ----------------------------------------------------------------------- // Setter methods // ----------------------------------------------------------------------- virtual void setStart(const DOMNode *refNode, XMLSize_t offset) = 0; virtual void setEnd(const DOMNode *refNode, XMLSize_t offset) = 0; virtual void setStartBefore(const DOMNode *refNode) = 0; virtual void setStartAfter(const DOMNode *refNode) = 0; virtual void setEndBefore(const DOMNode *refNode) = 0; virtual void setEndAfter(const DOMNode *refNode) = 0; // ----------------------------------------------------------------------- // Misc methods // ----------------------------------------------------------------------- virtual void collapse(bool toStart) = 0; virtual void selectNode(const DOMNode *refNode) = 0; virtual void selectNodeContents(const DOMNode *refNode) = 0; virtual short compareBoundaryPoints(CompareHow how, const DOMRange* sourceRange) const = 0; virtual void deleteContents() = 0; virtual DOMDocumentFragment* extractContents() = 0; virtual DOMDocumentFragment* cloneContents() const = 0; virtual void insertNode(DOMNode *newNode) = 0; virtual void surroundContents(DOMNode *newParent) = 0; virtual DOMRange* cloneRange() const = 0; virtual const XMLCh* toString() const = 0; virtual void detach() = 0; // ----------------------------------------------------------------------- // Non-standard Extension // ----------------------------------------------------------------------- virtual void release() = 0; }; XERCES_CPP_NAMESPACE_END #endif

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