http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Download
Installation
Build

API Docs
Samples
Schema

FAQs
Programming
Migration

Releases
Bug-Reporting
Feedback

Y2K Compliance
PDF Document

CVS Repository
Mail Archive

API Docs for SAX and DOM
 

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

IDOM_Range.hpp

Go to the documentation of this file.
00001 #ifndef IDOM_Range_HEADER_GUARD_
00002 #define IDOM_Range_HEADER_GUARD_
00003 
00004 /*
00005  * The Apache Software License, Version 1.1
00006  *
00007  * Copyright (c) 2001 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: IDOM_Range.hpp,v 1.1.1.1 2002/02/01 22:21:56 peiyongz Exp $
00062  */
00063 
00064 #include <xercesc/util/XercesDefs.hpp>
00065 
00066 class IDOM_Node;
00067 class IDOM_DocumentFragment;
00068 
00069 class  IDOM_Range {
00070 protected:
00071     IDOM_Range() {};
00072     IDOM_Range(const IDOM_Range &other) {};
00073     IDOM_Range & operator = (const IDOM_Range &other) {return *this;};
00074 
00075 public:
00076 
00077     enum CompareHow {
00078         START_TO_START  = 0,
00079         START_TO_END    = 1,
00080         END_TO_END      = 2,
00081         END_TO_START    = 3
00082     };
00083 
00084     virtual ~IDOM_Range() {};
00085 
00086     //getter functions
00087     virtual IDOM_Node* getStartContainer() const = 0;
00088     virtual unsigned int getStartOffset() const = 0;
00089     virtual IDOM_Node* getEndContainer() const = 0;
00090     virtual unsigned int getEndOffset() const = 0;
00091     virtual bool getCollapsed() const = 0;
00092     virtual const IDOM_Node* getCommonAncestorContainer() const = 0;
00093 
00094     //setter functions
00095     virtual void setStart(const IDOM_Node *parent, unsigned int offset) = 0;
00096     virtual void setEnd(const IDOM_Node *parent, unsigned int offset) = 0;
00097 
00098     virtual void setStartBefore(const IDOM_Node *refNode) = 0;
00099     virtual void setStartAfter(const IDOM_Node *refNode) = 0;
00100     virtual void setEndBefore(const IDOM_Node *refNode) = 0;
00101     virtual void setEndAfter(const IDOM_Node *refNode) = 0;
00102 
00103     //misc functions
00104     virtual void collapse(bool toStart) = 0;
00105     virtual void selectNode(const IDOM_Node *node) = 0;
00106     virtual void selectNodeContents(const IDOM_Node *node) = 0;
00107 
00108     //Functions related to comparing range Boundrary-Points
00109     virtual short compareBoundaryPoints(CompareHow how, const IDOM_Range* range) const = 0;
00110     virtual void deleteContents() = 0;
00111     virtual IDOM_DocumentFragment* extractContents() = 0;
00112     virtual IDOM_DocumentFragment* cloneContents() const = 0;
00113     virtual void insertNode(IDOM_Node *node) = 0;
00114     //Misc functions
00115     virtual void surroundContents(IDOM_Node *node) = 0;
00116     virtual IDOM_Range* cloneRange() const = 0;
00117     virtual const XMLCh* toString() const = 0;
00118     virtual void detach() = 0;
00119 
00120 };
00121 
00122 
00123 #endif


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