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

Home

Readme
Installation
Build

API Docs
Samples
Programming
Migration
FAQs

Releases
Feedback

PDF Document

Download
Dev Snapshots
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_TreeWalker.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  * $Log: DOM_TreeWalker.hpp,v $
00059  * Revision 1.8  2000/02/24 20:11:29  abagchi
00060  * Swat for removing Log from API docs
00061  *
00062  * Revision 1.7  2000/02/17 17:47:25  andyh
00063  * Update Doc++ API comments
00064  * NameSpace update to track W3C
00065  * Changes were made by Chih Hsiang Chou
00066  *
00067  * Revision 1.6  2000/02/15 23:17:37  andyh
00068  * Update Doc++ API comments
00069  * NameSpace bugfix and update to track W3C
00070  * Chih Hsiang Chou
00071  *
00072  * Revision 1.5  2000/02/11 03:01:04  abagchi
00073  * Made protected method public to compile, must be fixed later
00074  *
00075  * Revision 1.4  2000/02/11 01:05:11  abagchi
00076  * Added API docs
00077  *
00078  * Revision 1.3  2000/02/06 07:47:31  rahulj
00079  * Year 2K copyright swat.
00080  *
00081  * Revision 1.2  2000/02/04 01:49:27  aruna1
00082  * TreeWalker and NodeIterator changes
00083  *
00084  * Revision 1.1.1.1  1999/11/09 01:09:05  twl
00085  * Initial checkin
00086  *
00087  * Revision 1.3  1999/11/08 20:44:22  rahul
00088  * Swat for adding in Product name and CVS comment log variable.
00089  *
00090  */
00091 
00092 #ifndef DOM_TreeWalker_HEADER_GUARD_
00093 #define DOM_TreeWalker_HEADER_GUARD_
00094 
00095 #include "DOM_Node.hpp"
00096 #include "DOM_NodeFilter.hpp"
00097 
00098 class TreeWalkerImpl;
00099 
00100 
00119 class  DOM_TreeWalker {
00120     public:
00122         //@{
00126         DOM_TreeWalker();
00127 
00133         DOM_TreeWalker(const DOM_TreeWalker &other);
00134 
00140         DOM_TreeWalker & operator = (const DOM_TreeWalker &other);
00141 
00148         DOM_TreeWalker & operator = (const DOM_NullPtr *val);
00149         //@}
00150 
00152         //@{
00156         ~DOM_TreeWalker();
00157         //@}
00158 
00160         //@{
00168         bool operator == (const DOM_TreeWalker & other)const;
00169 
00174         bool operator == (const DOM_NullPtr *other) const;
00175 
00179         bool operator != (const DOM_TreeWalker & other) const;
00180 
00186         bool operator != (const DOM_NullPtr * other) const;
00187         //@}
00188 
00190         //@{
00198         unsigned long       getWhatToShow();
00199 
00206         DOM_NodeFilter*     getFilter();
00207 
00216         bool getExpandEntityReferences();
00217 
00224         DOM_Node        getCurrentNode();
00225 
00235         DOM_Node        parentNode();
00236 
00245         DOM_Node        firstChild();
00246 
00255         DOM_Node        lastChild();
00256 
00265         DOM_Node        previousSibling();
00266 
00275         DOM_Node        nextSibling();
00276 
00287         DOM_Node        previousNode();
00288 
00299         DOM_Node        nextNode();
00300         //@}
00301 
00303         //@{
00310         void            setCurrentNode(DOM_Node currentNode);
00311         //@}
00312 
00314         //@{
00324         void            detach();
00325         //@}
00326 
00327     protected:
00328         DOM_TreeWalker(TreeWalkerImpl* impl);
00329 
00330         friend class DOM_Document;
00331 
00332     private:
00333         TreeWalkerImpl*         fImpl;
00334 };
00335 
00336 #endif


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