Back to index

lightning-sunbird  0.9+nobinonly
nsIContentSerializer.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef _nsIContentSerializer_h__
00039 #define _nsIContentSerializer_h__
00040 
00041 #include "nsISupports.h"
00042 #include "nsAString.h"
00043 #include "nsIAtom.h"
00044 
00045 class nsIDOMText; /* forward declaration */
00046 class nsIDOMCDATASection; /* forward declaration */
00047 class nsIDOMProcessingInstruction; /* forward declaration */
00048 class nsIDOMComment; /* forward declaration */
00049 class nsIDOMDocumentType; /* forward declaration */
00050 class nsIDOMElement; /* forward declaration */
00051 class nsIDOMDocument; /* forward declaration */
00052 
00053 /* starting interface:    nsIContentSerializer */
00054 
00055 /* d650439a-ca29-410d-a906-b0557fb62fcd */
00056 #define NS_ICONTENTSERIALIZER_IID \
00057 {   0xd650439a, \
00058     0xca29, \
00059     0x410d, \
00060     {0xa9, 0x06, 0xb0, 0x55, 0x7f, 0xb6, 0x2f, 0xcd} }
00061 
00062 class nsIContentSerializer : public nsISupports {
00063  public: 
00064 
00065   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ICONTENTSERIALIZER_IID)
00066 
00067   NS_IMETHOD Init(PRUint32 flags, PRUint32 aWrapColumn,
00068                   const char* aCharSet, PRBool aIsCopying) = 0;
00069 
00070   NS_IMETHOD AppendText(nsIDOMText* aText, PRInt32 aStartOffset,
00071                         PRInt32 aEndOffset, nsAString& aStr) = 0;
00072 
00073   NS_IMETHOD AppendCDATASection(nsIDOMCDATASection* aCDATASection,
00074                                 PRInt32 aStartOffset, PRInt32 aEndOffset,
00075                                 nsAString& aStr) = 0;
00076 
00077   NS_IMETHOD AppendProcessingInstruction(nsIDOMProcessingInstruction* aPI,
00078                                          PRInt32 aStartOffset,
00079                                          PRInt32 aEndOffset,
00080                                          nsAString& aStr) = 0;
00081 
00082   NS_IMETHOD AppendComment(nsIDOMComment* aComment, PRInt32 aStartOffset,
00083                            PRInt32 aEndOffset, nsAString& aStr) = 0;
00084 
00085   NS_IMETHOD AppendDoctype(nsIDOMDocumentType *aDoctype,
00086                            nsAString& aStr) = 0;
00087 
00088   NS_IMETHOD AppendElementStart(nsIDOMElement *aElement,
00089                                 PRBool aHasChildren,
00090                                 nsAString& aStr) = 0;
00091 
00092   NS_IMETHOD AppendElementEnd(nsIDOMElement *aElement,
00093                               nsAString& aStr) = 0;
00094 
00095   NS_IMETHOD Flush(nsAString& aStr) = 0;
00096 
00102   NS_IMETHOD AppendDocumentStart(nsIDOMDocument *aDocument,
00103                                  nsAString& aStr) = 0;
00104 };
00105 
00106 #define NS_CONTENTSERIALIZER_CONTRACTID_PREFIX \
00107 "@mozilla.org/layout/contentserializer;1?mimetype="
00108 
00109 #endif /* __gen_nsIContentSerializer_h__ */