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

Home

Readme
Release Info

Installation
Download
Build

FAQs
Samples
API Docs

DOM C++ Binding
Programming
Migration Guide

Feedback
Bug-Reporting
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  

DOMNodeIterator.hpp

Go to the documentation of this file.
00001 #ifndef DOMNodeIterator_HEADER_GUARD_
00002 #define DOMNodeIterator_HEADER_GUARD_
00003 
00004 /*
00005  * The Apache Software License, Version 1.1
00006  *
00007  * Copyright (c) 2001-2002 The Apache Software Foundation.  All rights
00008  * reserved.
00009  *
00010  * Redistribution and use in source and binary forms, with or without
00011  * modification, are permitted provided that the following conditions
00012  * are met:
00013  *
00014  * 1. Redistributions of source code must retain the above copyright
00015  *    notice, this list of conditions and the following disclaimer.
00016  *
00017  * 2. Redistributions in binary form must reproduce the above copyright
00018  *    notice, this list of conditions and the following disclaimer in
00019  *    the documentation and/or other materials provided with the
00020  *    distribution.
00021  *
00022  * 3. The end-user documentation included with the redistribution,
00023  *    if any, must include the following acknowledgment:
00024  *       "This product includes software developed by the
00025  *        Apache Software Foundation (http://www.apache.org/)."
00026  *    Alternately, this acknowledgment may appear in the software itself,
00027  *    if and wherever such third-party acknowledgments normally appear.
00028  *
00029  * 4. The names "Xerces" and "Apache Software Foundation" must
00030  *    not be used to endorse or promote products derived from this
00031  *    software without prior written permission. For written
00032  *    permission, please contact apache\@apache.org.
00033  *
00034  * 5. Products derived from this software may not be called "Apache",
00035  *    nor may "Apache" appear in their name, without prior written
00036  *    permission of the Apache Software Foundation.
00037  *
00038  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00039  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00040  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00041  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00042  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00043  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00044  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00045  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00046  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00047  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00048  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00049  * SUCH DAMAGE.
00050  * ====================================================================
00051  *
00052  * This software consists of voluntary contributions made by many
00053  * individuals on behalf of the Apache Software Foundation, and was
00054  * originally based on software copyright (c) 2001, International
00055  * Business Machines, Inc., http://www.ibm.com .  For more information
00056  * on the Apache Software Foundation, please see
00057  * <http://www.apache.org/>.
00058  */
00059 
00060 /*
00061  * $Id: DOMNodeIterator.hpp,v 1.7 2003/03/07 19:59:07 tng Exp $
00062  */
00063 
00064 #include "DOMNodeFilter.hpp"
00065 #include "DOMNode.hpp"
00066 
00067 XERCES_CPP_NAMESPACE_BEGIN
00068 
00069 
00083 class  DOMNodeIterator
00084 {
00085 protected:
00086     // -----------------------------------------------------------------------
00087     //  Hidden constructors
00088     // -----------------------------------------------------------------------
00091     DOMNodeIterator() {};
00093 
00094 private:    
00095     // -----------------------------------------------------------------------
00096     // Unimplemented constructors and operators
00097     // -----------------------------------------------------------------------
00100     DOMNodeIterator(const DOMNodeIterator &);
00101     DOMNodeIterator & operator = (const DOMNodeIterator &);
00103 
00104 public:
00105     // -----------------------------------------------------------------------
00106     //  All constructors are hidden, just the destructor is available
00107     // -----------------------------------------------------------------------
00114     virtual ~DOMNodeIterator() {};
00116 
00117     // -----------------------------------------------------------------------
00118     //  Virtual DOMNodeFilter interface
00119     // -----------------------------------------------------------------------
00122     // -----------------------------------------------------------------------
00123     //  Getter methods
00124     // -----------------------------------------------------------------------
00130     virtual DOMNode*           getRoot() = 0;
00142     virtual unsigned long      getWhatToShow() = 0;
00143 
00149     virtual DOMNodeFilter*     getFilter() = 0;
00150 
00172     virtual bool               getExpandEntityReferences() = 0;
00173 
00174     // -----------------------------------------------------------------------
00175     //  Query methods
00176     // -----------------------------------------------------------------------
00189     virtual DOMNode*           nextNode() = 0;
00190 
00201     virtual DOMNode*           previousNode() = 0;
00202 
00212     virtual void               detach() = 0;
00214 
00215     // -----------------------------------------------------------------------
00216     //  Non-standard Extension
00217     // -----------------------------------------------------------------------
00227     virtual void               release() = 0;
00229 };
00230 
00231 XERCES_CPP_NAMESPACE_END
00232 
00233 #endif


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