Back to index

lightning-sunbird  0.9+nobinonly
nsIContentSink.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 Communicator client 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 #ifndef nsIContentSink_h___
00038 #define nsIContentSink_h___
00039 
00051 #include "nsISupports.h"
00052 #include "nsString.h"
00053 #include "mozFlushType.h"
00054 
00055 class nsIParser;
00056 
00057 #define NS_ICONTENT_SINK_IID \
00058 { 0x94ec4df1, 0x6885, 0x4b1f, \
00059  { 0x85, 0x10, 0xe3, 0x5f, 0x4f, 0x36, 0xea, 0xaa } }
00060 
00061 // The base value for the content ID counter.
00062 // Values greater than or equal to this base value are used
00063 // by each of the content sinks to assign unique values
00064 // to the content objects created by them.
00065 #define NS_CONTENT_ID_COUNTER_BASE 10000
00066 
00067 class nsIContentSink : public nsISupports {
00068 public:
00069 
00070   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ICONTENT_SINK_IID)
00071 
00072   
00078   NS_IMETHOD WillBuildModel(void)=0;
00079 
00086   NS_IMETHOD DidBuildModel()=0;
00087 
00095   NS_IMETHOD WillInterrupt(void)=0;
00096 
00103   NS_IMETHOD WillResume(void)=0;
00104 
00111   NS_IMETHOD SetParser(nsIParser* aParser)=0;
00112 
00119   virtual void FlushPendingNotifications(mozFlushType aType)=0;
00120 
00125   NS_IMETHOD SetDocumentCharset(nsACString& aCharset)=0;
00126 
00132   virtual nsISupports *GetTarget()=0;
00133 };
00134 
00135 #endif /* nsIContentSink_h___ */