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.3 2002/02/20 18:17:00 tng
00060 * [Bug 5977] Warnings on generating apiDocs.
00061 *
00062 * Revision 1.2 2002/02/04 20:03:48 tng
00063 * Add DOM Level missing functions:
00064 * 1. NodeIterator::getRoot
00065 * 2. TreeWalker::getRoot
00066 * 3. Element::hasAttribute
00067 * 4. Element::hasAttributeNS
00068 * 5. Node::hasAttributes
00069 * 6. Node::isSupported
00070 *
00071 * Revision 1.1.1.1 2002/02/01 22:21:46 peiyongz
00072 * sane_include
00073 *
00074 * Revision 1.9 2000/08/08 01:00:36 aruna1
00075 * detach functionality removed from TreeWalker
00076 *
00077 * Revision 1.8 2000/02/24 20:11:29 abagchi
00078 * Swat for removing Log from API docs
00079 *
00080 * Revision 1.7 2000/02/17 17:47:25 andyh
00081 * Update Doc++ API comments
00082 * NameSpace update to track W3C
00083 * Changes were made by Chih Hsiang Chou
00084 *
00085 * Revision 1.6 2000/02/15 23:17:37 andyh
00086 * Update Doc++ API comments
00087 * NameSpace bugfix and update to track W3C
00088 * Chih Hsiang Chou
00089 *
00090 * Revision 1.5 2000/02/11 03:01:04 abagchi
00091 * Made protected method public to compile, must be fixed later
00092 *
00093 * Revision 1.4 2000/02/11 01:05:11 abagchi
00094 * Added API docs
00095 *
00096 * Revision 1.3 2000/02/06 07:47:31 rahulj
00097 * Year 2K copyright swat.
00098 *
00099 * Revision 1.2 2000/02/04 01:49:27 aruna1
00100 * TreeWalker and NodeIterator changes
00101 *
00102 * Revision 1.1.1.1 1999/11/09 01:09:05 twl
00103 * Initial checkin
00104 *
00105 * Revision 1.3 1999/11/08 20:44:22 rahul
00106 * Swat for adding in Product name and CVS comment log variable.
00107 *
00108 */
00109
00110 #ifndef DOM_TreeWalker_HEADER_GUARD_
00111 #define DOM_TreeWalker_HEADER_GUARD_
00112
00113 #include "DOM_Node.hpp"
00114 #include "DOM_NodeFilter.hpp"
00115
00116 class TreeWalkerImpl;
00117
00118
00135 class DOM_TreeWalker {
00136 public:
00139
00142 DOM_TreeWalker();
00143
00149 DOM_TreeWalker(const DOM_TreeWalker &other);
00150
00156 DOM_TreeWalker & operator = (const DOM_TreeWalker &other);
00157
00164 DOM_TreeWalker & operator = (const DOM_NullPtr *val);
00166
00169
00172 ~DOM_TreeWalker();
00174
00177
00184 bool operator == (const DOM_TreeWalker & other)const;
00185
00190 bool operator == (const DOM_NullPtr *other) const;
00191
00195 bool operator != (const DOM_TreeWalker & other) const;
00196
00202 bool operator != (const DOM_NullPtr * other) const;
00204
00207
00211 DOM_NodegetRoot();
00212
00218 unsigned long getWhatToShow();
00219
00224 DOM_NodeFilter* getFilter();
00225
00232 bool getExpandEntityReferences();
00233
00238 DOM_NodegetCurrentNode();
00239
00247 DOM_NodeparentNode();
00248
00255 DOM_NodefirstChild();
00256
00263 DOM_NodelastChild();
00264
00271 DOM_NodepreviousSibling();
00272
00279 DOM_NodenextSibling();
00280
00289 DOM_NodepreviousNode();
00290
00299 DOM_NodenextNode();
00301
00304
00308 void setCurrentNode(DOM_Node currentNode);
00310
00311
00312 protected:
00313 DOM_TreeWalker(TreeWalkerImpl* impl);
00314
00315 friend class DOM_Document;
00316
00317 private:
00318 TreeWalkerImpl* fImpl;
00319 };
00320
00321 #endif