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  

DOMWriter.hpp

Go to the documentation of this file.
00001 #ifndef DOMWriter_HEADER_GUARD_
00002 #define DOMWriter_HEADER_GUARD_
00003 
00004 /*
00005  * The Apache Software License, Version 1.1
00006  *
00007  * Copyright (c) 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) 1999, 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: DOMWriter.hpp,v 1.10 2003/03/07 19:59:09 tng Exp $
00062  * $Log: DOMWriter.hpp,v $
00063  * Revision 1.10  2003/03/07 19:59:09  tng
00064  * [Bug 11692] Unimplement the hidden constructors and assignment operator to remove warnings from gcc.
00065  *
00066  * Revision 1.9  2002/11/27 18:46:39  tng
00067  * Documentation: clarify that DOMWriter::writeToString always returns string in UTF-16
00068  *
00069  * Revision 1.8  2002/11/04 15:09:25  tng
00070  * C++ Namespace Support.
00071  *
00072  * Revision 1.7  2002/08/22 15:04:57  tng
00073  * Remove unused parameter variables in inline functions.
00074  *
00075  * Revision 1.6  2002/06/25 16:04:49  tng
00076  * DOM L3: add function release().
00077  *
00078  * Revision 1.5  2002/06/06 20:53:07  tng
00079  * Documentation Fix: Update the API Documentation for DOM headers
00080  *
00081  * Revision 1.4  2002/06/03 22:33:21  peiyongz
00082  * DOMWriter: constants moved to XMLUni
00083  *
00084  * Revision 1.3  2002/05/31 20:59:40  peiyongz
00085  * Add "introduced in DOM3"
00086  *
00087  * Revision 1.2  2002/05/30 16:25:33  tng
00088  * Fix doxygen warning message.
00089  *
00090  * Revision 1.1  2002/05/28 22:38:55  peiyongz
00091  * DOM3 Save Interface: DOMWriter/DOMWriterFilter
00092  *
00093  */
00094 
00315 #include <xercesc/dom/DOMNode.hpp>
00316 #include <xercesc/dom/DOMWriterFilter.hpp>
00317 #include <xercesc/dom/DOMErrorHandler.hpp>
00318 #include <xercesc/framework/XMLFormatter.hpp>
00319 
00320 XERCES_CPP_NAMESPACE_BEGIN
00321 
00322 class  DOMWriter {
00323 protected :
00324     // -----------------------------------------------------------------------
00325     //  Hidden constructors
00326     // -----------------------------------------------------------------------
00329     DOMWriter() {};
00331 private:        
00332     // -----------------------------------------------------------------------
00333     // Unimplemented constructors and operators
00334     // -----------------------------------------------------------------------
00337     DOMWriter(const DOMWriter &);
00338     DOMWriter & operator = (const DOMWriter &);
00340 
00341 
00342 public:
00343     // -----------------------------------------------------------------------
00344     //  All constructors are hidden, just the destructor is available
00345     // -----------------------------------------------------------------------
00352     virtual ~DOMWriter() {};
00354 
00355     // -----------------------------------------------------------------------
00356     //  Virtual DOMWriter interface
00357     // -----------------------------------------------------------------------
00360     // -----------------------------------------------------------------------
00361     //  Feature methods
00362     // -----------------------------------------------------------------------
00378     virtual bool           canSetFeature(const XMLCh* const featName
00379                                        , bool               state) const = 0;
00399     virtual void            setFeature(const XMLCh* const featName
00400                                      , bool               state) = 0;
00401 
00418     virtual bool               getFeature(const XMLCh* const featName) const = 0;
00419 
00420     // -----------------------------------------------------------------------
00421     //  Setter methods
00422     // -----------------------------------------------------------------------
00439     virtual void           setEncoding(const XMLCh* const encoding) = 0;
00440 
00469     virtual void          setNewLine(const XMLCh* const newLine) = 0;
00470 
00484     virtual void         setErrorHandler(DOMErrorHandler *errorHandler) = 0;
00485 
00498     virtual void         setFilter(DOMWriterFilter *filter) = 0;
00499 
00500     // -----------------------------------------------------------------------
00501     //  Getter methods
00502     // -----------------------------------------------------------------------
00512      virtual const XMLCh*       getEncoding() const = 0;
00513 
00524      virtual const XMLCh*       getNewLine() const = 0;
00525 
00536      virtual DOMErrorHandler*   getErrorHandler() const = 0;
00537 
00547      virtual DOMWriterFilter*   getFilter() const = 0;
00548 
00549     // -----------------------------------------------------------------------
00550     //  Write methods
00551     // -----------------------------------------------------------------------
00575     virtual bool       writeNode(XMLFormatTarget* const destination
00576                                , const DOMNode         &nodeToWrite) = 0;
00577 
00596     virtual XMLCh*     writeToString(const DOMNode &nodeToWrite) = 0;
00597 
00599 
00600     // -----------------------------------------------------------------------
00601     //  Non-standard Extension
00602     // -----------------------------------------------------------------------
00611     virtual void              release() = 0;
00613 
00614 
00615 };
00616 
00617 XERCES_CPP_NAMESPACE_END
00618 
00619 #endif


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