Back to index

lightning-sunbird  0.9+nobinonly
nsDummyLayoutRequest.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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) 2002
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 nsDummyLayoutRequest_h__
00039 #define nsDummyLayoutRequest_h__
00040 
00041 #include "nsIChannel.h"
00042 #include "nsILoadGroup.h"
00043 #include "nsNetUtil.h"
00044 #include "nsWeakPtr.h"
00045 
00046 //----------------------------------------------------------------------
00047 //
00048 // DummyLayoutRequest
00049 //
00050 //   This is a dummy request implementation that we add to the document's load
00051 //   group. It ensures that EndDocumentLoad() in the docshell doesn't fire
00052 //   before we've finished all of layout.
00053 //
00054 
00055 class nsDummyLayoutRequest : public nsIChannel
00056 {
00057 protected:
00058   nsDummyLayoutRequest(nsIPresShell* aPresShell);
00059   virtual ~nsDummyLayoutRequest();
00060 
00061   static PRInt32 gRefCnt;
00062   static nsIURI* gURI;
00063 
00064   nsCOMPtr<nsILoadGroup> mLoadGroup;
00065   nsWeakPtr mPresShell;
00066 
00067 public:
00068   static nsresult
00069   Create(nsIRequest** aResult, nsIPresShell* aPresShell);
00070 
00071   NS_DECL_ISUPPORTS
00072 
00073        // nsIRequest
00074   NS_IMETHOD GetName(nsACString &result) { 
00075     result.AssignLiteral("about:layout-dummy-request");
00076     return NS_OK;
00077   }
00078   NS_IMETHOD IsPending(PRBool *_retval) { *_retval = PR_TRUE; return NS_OK; }
00079   NS_IMETHOD GetStatus(nsresult *status) { *status = NS_OK; return NS_OK; } 
00080   NS_IMETHOD Cancel(nsresult status);
00081   NS_IMETHOD Suspend(void) { return NS_OK; }
00082   NS_IMETHOD Resume(void)  { return NS_OK; }
00083   NS_IMETHOD GetLoadGroup(nsILoadGroup * *aLoadGroup) { *aLoadGroup = mLoadGroup; NS_IF_ADDREF(*aLoadGroup); return NS_OK; }
00084   NS_IMETHOD SetLoadGroup(nsILoadGroup * aLoadGroup) { mLoadGroup = aLoadGroup; return NS_OK; }
00085   NS_IMETHOD GetLoadFlags(nsLoadFlags *aLoadFlags) { *aLoadFlags = nsIRequest::LOAD_NORMAL; return NS_OK; }
00086   NS_IMETHOD SetLoadFlags(nsLoadFlags aLoadFlags) { return NS_OK; }
00087 
00088        // nsIChannel
00089   NS_IMETHOD GetOriginalURI(nsIURI* *aOriginalURI) { *aOriginalURI = gURI; NS_ADDREF(*aOriginalURI); return NS_OK; }
00090   NS_IMETHOD SetOriginalURI(nsIURI* aOriginalURI) { gURI = aOriginalURI; NS_ADDREF(gURI); return NS_OK; }
00091   NS_IMETHOD GetURI(nsIURI* *aURI) { *aURI = gURI; NS_ADDREF(*aURI); return NS_OK; }
00092   NS_IMETHOD SetURI(nsIURI* aURI) { gURI = aURI; NS_ADDREF(gURI); return NS_OK; }
00093   NS_IMETHOD Open(nsIInputStream **_retval) { *_retval = nsnull; return NS_OK; }
00094   NS_IMETHOD AsyncOpen(nsIStreamListener *listener, nsISupports *ctxt) { return NS_OK; }
00095   NS_IMETHOD GetOwner(nsISupports * *aOwner) { *aOwner = nsnull; return NS_OK; }
00096   NS_IMETHOD SetOwner(nsISupports * aOwner) { return NS_OK; }
00097   NS_IMETHOD GetNotificationCallbacks(nsIInterfaceRequestor * *aNotificationCallbacks) { *aNotificationCallbacks = nsnull; return NS_OK; }
00098   NS_IMETHOD SetNotificationCallbacks(nsIInterfaceRequestor * aNotificationCallbacks) { return NS_OK; }
00099   NS_IMETHOD GetSecurityInfo(nsISupports * *aSecurityInfo) { *aSecurityInfo = nsnull; return NS_OK; } 
00100   NS_IMETHOD GetContentType(nsACString &aContentType) { aContentType.Truncate(); return NS_OK; } 
00101   NS_IMETHOD SetContentType(const nsACString &aContentType) { return NS_OK; } 
00102   NS_IMETHOD GetContentCharset(nsACString &aContentCharset) { aContentCharset.Truncate(); return NS_OK; } 
00103   NS_IMETHOD SetContentCharset(const nsACString &aContentCharset) { return NS_OK; } 
00104   NS_IMETHOD GetContentLength(PRInt32 *aContentLength) { return NS_OK; }
00105   NS_IMETHOD SetContentLength(PRInt32 aContentLength) { return NS_OK; }
00106 };
00107 
00108 #endif