DOM_TreeWalker.hpp Source 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.9  2000/08/08 01:00:36  aruna1
00060  * detach functionality removed from TreeWalker
00061  *
00062  * Revision 1.8  2000/02/24 20:11:29  abagchi
00063  * Swat for removing Log from API docs
00064  *
00065  * Revision 1.7  2000/02/17 17:47:25  andyh
00066  * Update Doc++ API comments
00067  * NameSpace update to track W3C
00068  * Changes were made by Chih Hsiang Chou
00069  *
00070  * Revision 1.6  2000/02/15 23:17:37  andyh
00071  * Update Doc++ API comments
00072  * NameSpace bugfix and update to track W3C
00073  * Chih Hsiang Chou
00074  *
00075  * Revision 1.5  2000/02/11 03:01:04  abagchi
00076  * Made protected method public to compile, must be fixed later
00077  *
00078  * Revision 1.4  2000/02/11 01:05:11  abagchi
00079  * Added API docs
00080  *
00081  * Revision 1.3  2000/02/06 07:47:31  rahulj
00082  * Year 2K copyright swat.
00083  *
00084  * Revision 1.2  2000/02/04 01:49:27  aruna1
00085  * TreeWalker and NodeIterator changes
00086  *
00087  * Revision 1.1.1.1  1999/11/09 01:09:05  twl
00088  * Initial checkin
00089  *
00090  * Revision 1.3  1999/11/08 20:44:22  rahul
00091  * Swat for adding in Product name and CVS comment log variable.
00092  *
00093  */
00094 
00095 #ifndef DOM_TreeWalker_HEADER_GUARD_
00096 #define DOM_TreeWalker_HEADER_GUARD_
00097 
00098 #include "DOM_Node.hpp"
00099 #include "DOM_NodeFilter.hpp"
00100 
00101 class TreeWalkerImpl;
00102 
00103 
00122 class  DOM_TreeWalker {
00123     public:
00126 
00129         DOM_TreeWalker();
00130 
00136         DOM_TreeWalker(const DOM_TreeWalker &other);
00137 
00143         DOM_TreeWalker & operator = (const DOM_TreeWalker &other);
00144 
00151         DOM_TreeWalker & operator = (const DOM_NullPtr *val);
00153 
00156 
00159         ~DOM_TreeWalker();
00161 
00164 
00171         bool operator == (const DOM_TreeWalker & other)const;
00172 
00177         bool operator == (const DOM_NullPtr *other) const;
00178 
00182         bool operator != (const DOM_TreeWalker & other) const;
00183 
00189         bool operator != (const DOM_NullPtr * other) const;
00191 
00194 
00201         unsigned long       getWhatToShow();
00202 
00209         DOM_NodeFilter*     getFilter();
00210 
00219         bool getExpandEntityReferences();
00220 
00227         DOM_Node        getCurrentNode();
00228 
00238         DOM_Node        parentNode();
00239 
00248         DOM_Node        firstChild();
00249 
00258         DOM_Node        lastChild();
00259 
00268         DOM_Node        previousSibling();
00269 
00278         DOM_Node        nextSibling();
00279 
00290         DOM_Node        previousNode();
00291 
00302         DOM_Node        nextNode();
00304 
00307 
00313         void            setCurrentNode(DOM_Node currentNode);
00315 
00316         
00317     protected:
00318         DOM_TreeWalker(TreeWalkerImpl* impl);
00319 
00320         friend class DOM_Document;
00321 
00322     private:
00323         TreeWalkerImpl*         fImpl;
00324 };
00325 
00326 #endif