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  

DOM_Range.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
00005  * reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  *
00026  * 4. The names "Xerces" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written
00029  *    permission, please contact apache\@apache.org.
00030  *
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  *
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  *
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation, and was
00051  * originally based on software copyright (c) 1999, International
00052  * Business Machines, Inc., http://www.ibm.com .  For more information
00053  * on the Apache Software Foundation, please see
00054  * <http://www.apache.org/>.
00055  */
00056 
00057 /*
00058  * $Id: DOM_Range.hpp,v 1.1.1.1 2002/02/01 22:21:46 peiyongz Exp $
00059  */
00060 
00061 #ifndef DOM_Range_HEADER_GUARD_
00062 #define DOM_Range_HEADER_GUARD_
00063 
00064 #include <xercesc/util/XercesDefs.hpp>
00065 #include <xercesc/dom/DOM_Node.hpp>
00066 #include <xercesc/dom/DOMString.hpp>
00067 #include <xercesc/dom/DOM_DocumentFragment.hpp>
00068 
00069 class RangeImpl;
00070 
00071 //class RangeImpl;
00072 
00073 class  DOM_Range {
00074 public:
00075 
00076     enum CompareHow {
00077         START_TO_START  = 0,
00078         START_TO_END    = 1,
00079         END_TO_END      = 2,
00080         END_TO_START    = 3
00081     };
00082 
00083     //c'tor & d'tor
00084     DOM_Range();
00085     DOM_Range(const DOM_Range& other);
00086     ~DOM_Range();
00087 
00088     
00089     DOM_Range & operator = (const DOM_Range &other);
00090     DOM_Range & operator = (const DOM_NullPtr *other);
00091     bool operator != (const DOM_Range & other) const;
00092     bool operator == (const DOM_Range & other) const;
00093     bool operator != (const DOM_NullPtr * other) const;
00094     bool operator == (const DOM_NullPtr * other) const;
00095 
00096     //getter functions
00097     DOM_Node getStartContainer() const;
00098     unsigned int getStartOffset() const;
00099     DOM_Node getEndContainer() const;
00100     unsigned int getEndOffset() const;
00101     bool getCollapsed() const;
00102     const DOM_Node getCommonAncestorContainer() const;
00103 
00104     //setter functions
00105     void setStart(const DOM_Node &parent, unsigned int offset);
00106     void setEnd(const DOM_Node &parent, unsigned int offset);
00107 
00108     void setStartBefore(const DOM_Node &refNode);
00109     void setStartAfter(const DOM_Node &refNode);
00110     void setEndBefore(const DOM_Node &refNode);
00111     void setEndAfter(const DOM_Node &refNode);
00112    
00113     //misc functions
00114     void collapse(bool toStart);
00115     void selectNode(const DOM_Node &node);
00116     void selectNodeContents(const DOM_Node &node);
00117 
00118     //Functions related to comparing range Boundrary-Points
00119     short compareBoundaryPoints(CompareHow how, const DOM_Range& range) const;
00120     void deleteContents();
00121     DOM_DocumentFragment extractContents();
00122     DOM_DocumentFragment cloneContents() const;
00123     void insertNode(DOM_Node& node);
00124     //Misc functions
00125     void surroundContents(DOM_Node &node);
00126     DOM_Range cloneRange() const;
00127     DOMString toString() const;
00128     void detach();
00129 
00130     
00131      
00132 
00133 protected:
00134 
00135     DOM_Range(RangeImpl *);
00136     RangeImpl   *fImpl;
00137 
00138     friend class DOM_Document;
00139 };
00140 
00141 
00142 
00143 
00144 #endif


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