Back to index

lightning-sunbird  0.9+nobinonly
nsIScriptGlobalObject.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* vim: set ts=2 sw=2 et tw=80: */
00003 /* ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is mozilla.org code.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 1998
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef nsIScriptGlobalObject_h__
00040 #define nsIScriptGlobalObject_h__
00041 
00042 #include "nsISupports.h"
00043 #include "nsEvent.h"
00044 
00045 class nsIScriptContext;
00046 class nsIDOMDocument;
00047 class nsIDOMEvent;
00048 class nsPresContext;
00049 class nsIDocShell;
00050 class nsIDOMWindowInternal;
00051 class nsIScriptGlobalObjectOwner;
00052 struct JSObject;
00053 
00054 #define NS_ISCRIPTGLOBALOBJECT_IID \
00055 { 0xd326a211, 0xdc31, 0x45c6, \
00056  { 0x98, 0x97, 0x22, 0x11, 0xea, 0xbc, 0xd0, 0x1c } }
00057 
00063 class nsIScriptGlobalObject : public nsISupports
00064 {
00065 public:
00066   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISCRIPTGLOBALOBJECT_IID)
00067 
00068   virtual void SetContext(nsIScriptContext *aContext) = 0;
00069   virtual nsIScriptContext *GetContext() = 0;
00070   virtual nsresult SetNewDocument(nsIDOMDocument *aDocument,
00071                                   nsISupports *aState,
00072                                   PRBool aRemoveEventListeners,
00073                                   PRBool aClearScope) = 0;
00074   virtual void SetDocShell(nsIDocShell *aDocShell) = 0;
00075   virtual nsIDocShell *GetDocShell() = 0;
00076   virtual void SetOpenerWindow(nsIDOMWindowInternal *aOpener)=0;
00077 
00084   virtual void SetGlobalObjectOwner(nsIScriptGlobalObjectOwner* aOwner) = 0;
00085 
00092   virtual nsIScriptGlobalObjectOwner *GetGlobalObjectOwner() = 0;
00093 
00094   virtual nsresult HandleDOMEvent(nsPresContext* aPresContext, 
00095                                   nsEvent* aEvent, 
00096                                   nsIDOMEvent** aDOMEvent,
00097                                   PRUint32 aFlags,
00098                                   nsEventStatus* aEventStatus)=0;
00099 
00100   virtual JSObject *GetGlobalJSObject() = 0;
00101 
00106   virtual void OnFinalize(JSObject *aJSObject) = 0;
00107 
00111   virtual void SetScriptsEnabled(PRBool aEnabled, PRBool aFireTimeouts) = 0;
00112 
00124   virtual nsresult SetNewArguments(PRUint32 aArgc, void* aArgv) = 0;
00125 };
00126 
00127 #endif