Main Page   Class Hierarchy   Compound List   File List   Compound Members  

DOM_TreeWalker.hpp

00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 1999-2002 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.1  2002/05/11 19:53:01  bhavani
00060  * CR#CR062582# adding xercesc 1.7 file
00061  *
00062  * Revision 1.3  2002/02/20 18:17:00  tng
00063  * [Bug 5977] Warnings on generating apiDocs.
00064  *
00065  * Revision 1.2  2002/02/04 20:03:48  tng
00066  * Add DOM Level missing functions:
00067  * 1. NodeIterator::getRoot
00068  * 2. TreeWalker::getRoot
00069  * 3. Element::hasAttribute
00070  * 4. Element::hasAttributeNS
00071  * 5. Node::hasAttributes
00072  * 6. Node::isSupported
00073  *
00074  * Revision 1.1.1.1  2002/02/01 22:21:46  peiyongz
00075  * sane_include
00076  *
00077  * Revision 1.9  2000/08/08 01:00:36  aruna1
00078  * detach functionality removed from TreeWalker
00079  *
00080  * Revision 1.8  2000/02/24 20:11:29  abagchi
00081  * Swat for removing Log from API docs
00082  *
00083  * Revision 1.7  2000/02/17 17:47:25  andyh
00084  * Update Doc++ API comments
00085  * NameSpace update to track W3C
00086  * Changes were made by Chih Hsiang Chou
00087  *
00088  * Revision 1.6  2000/02/15 23:17:37  andyh
00089  * Update Doc++ API comments
00090  * NameSpace bugfix and update to track W3C
00091  * Chih Hsiang Chou
00092  *
00093  * Revision 1.5  2000/02/11 03:01:04  abagchi
00094  * Made protected method public to compile, must be fixed later
00095  *
00096  * Revision 1.4  2000/02/11 01:05:11  abagchi
00097  * Added API docs
00098  *
00099  * Revision 1.3  2000/02/06 07:47:31  rahulj
00100  * Year 2K copyright swat.
00101  *
00102  * Revision 1.2  2000/02/04 01:49:27  aruna1
00103  * TreeWalker and NodeIterator changes
00104  *
00105  * Revision 1.1.1.1  1999/11/09 01:09:05  twl
00106  * Initial checkin
00107  *
00108  * Revision 1.3  1999/11/08 20:44:22  rahul
00109  * Swat for adding in Product name and CVS comment log variable.
00110  *
00111  */
00112 
00113 #ifndef DOM_TreeWalker_HEADER_GUARD_
00114 #define DOM_TreeWalker_HEADER_GUARD_
00115 
00116 #include "DOM_Node.hpp"
00117 #include "DOM_NodeFilter.hpp"
00118 
00119 class TreeWalkerImpl;
00120 
00121 
00138 class CDOM_EXPORT DOM_TreeWalker {
00139     public:
00145         DOM_TreeWalker();
00146 
00152         DOM_TreeWalker(const DOM_TreeWalker &other);
00153 
00159         DOM_TreeWalker & operator = (const DOM_TreeWalker &other);
00160 
00167         DOM_TreeWalker & operator = (const DOM_NullPtr *val);
00169 
00175         ~DOM_TreeWalker();
00177 
00187         bool operator == (const DOM_TreeWalker & other)const;
00188 
00193         bool operator == (const DOM_NullPtr *other) const;
00194 
00198         bool operator != (const DOM_TreeWalker & other) const;
00199 
00205         bool operator != (const DOM_NullPtr * other) const;
00207 
00214         DOM_Node          getRoot();
00215 
00221         unsigned long           getWhatToShow();
00222 
00227         DOM_NodeFilter*         getFilter();
00228 
00235         bool getExpandEntityReferences();
00236 
00241         DOM_Node                getCurrentNode();
00242 
00250         DOM_Node                parentNode();
00251 
00258         DOM_Node                firstChild();
00259 
00266         DOM_Node                lastChild();
00267 
00274         DOM_Node                previousSibling();
00275 
00282         DOM_Node                nextSibling();
00283 
00292         DOM_Node                previousNode();
00293 
00302         DOM_Node                nextNode();
00304 
00311         void                    setCurrentNode(DOM_Node currentNode);
00313 
00314 
00315     protected:
00316         DOM_TreeWalker(TreeWalkerImpl* impl);
00317 
00318         friend class DOM_Document;
00319 
00320     private:
00321         TreeWalkerImpl*         fImpl;
00322 };
00323 
00324 #endif

Generated on Tue Nov 19 09:36:28 2002 by doxygen1.3-rc1