content/base/public/nsIContentSerializer.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef _nsIContentSerializer_h__
  39 #define _nsIContentSerializer_h__
  40
  41 #include "nsISupports.h"
  42
  43 class nsIDOMText; /* forward declaration */
  44 class nsIDOMCDATASection; /* forward declaration */
  45 class nsIDOMProcessingInstruction; /* forward declaration */
  46 class nsIDOMComment; /* forward declaration */
  47 class nsIDOMDocumentType; /* forward declaration */
  48 class nsIDOMElement; /* forward declaration */
  49 class nsIDOMDocument; /* forward declaration */
  50 class nsAString;
  51
  52 /* starting interface:    nsIContentSerializer */
  53
  54 #define NS_ICONTENTSERIALIZER_IID \
  55 { 0x34769de0, 0x30d0, 0x4cef, \
  56   { 0x89, 0x4a, 0xfc, 0xd8, 0xbb, 0x27, 0xc4, 0xb4 } }
  57
  58 class nsIContentSerializer : public nsISupports {
  59  public:
  60
  61   NS_DECLARE_STATIC_IID_ACCESSOR(NS_ICONTENTSERIALIZER_IID)
  62
  63   NS_IMETHOD Init(PRUint32 flags, PRUint32 aWrapColumn,
  64                   const char* aCharSet, PRBool aIsCopying,
  65                   PRBool aIsWholeDocument) = 0;
  66
  67   NS_IMETHOD AppendText(nsIDOMText* aText, PRInt32 aStartOffset,
  68                         PRInt32 aEndOffset, nsAString& aStr) = 0;
  69
  70   NS_IMETHOD AppendCDATASection(nsIDOMCDATASection* aCDATASection,
  71                                 PRInt32 aStartOffset, PRInt32 aEndOffset,
  72                                 nsAString& aStr) = 0;
  73
  74   NS_IMETHOD AppendProcessingInstruction(nsIDOMProcessingInstruction* aPI,
  75                                          PRInt32 aStartOffset,
  76                                          PRInt32 aEndOffset,
  77                                          nsAString& aStr) = 0;
  78
  79   NS_IMETHOD AppendComment(nsIDOMComment* aComment, PRInt32 aStartOffset,
  80                            PRInt32 aEndOffset, nsAString& aStr) = 0;
  81
  82   NS_IMETHOD AppendDoctype(nsIDOMDocumentType *aDoctype,
  83                            nsAString& aStr) = 0;
  84
  85   NS_IMETHOD AppendElementStart(nsIDOMElement *aElement,
  86                                 nsIDOMElement *aOriginalElement,
  87                                 nsAString& aStr) = 0;
  88
  89   NS_IMETHOD AppendElementEnd(nsIDOMElement *aElement,
  90                               nsAString& aStr) = 0;
  91
  92   NS_IMETHOD Flush(nsAString& aStr) = 0;
  93
  94   /**
  95    * Append any items in the beginning of the document that won't be
  96    * serialized by other methods. XML declaration is the most likely
  97    * thing this method can produce.
  98    */
  99   NS_IMETHOD AppendDocumentStart(nsIDOMDocument *aDocument,
 100                                  nsAString& aStr) = 0;
 101 };
 102
 103 NS_DEFINE_STATIC_IID_ACCESSOR(nsIContentSerializer, NS_ICONTENTSERIALIZER_IID)
 104
 105 #define NS_CONTENTSERIALIZER_CONTRACTID_PREFIX \
 106 "@mozilla.org/layout/contentserializer;1?mimetype="
 107
 108 #endif /* __gen_nsIContentSerializer_h__ */