Mozilla/mozilla/dom/public/base/nsPIDOMWindow.h
2004-09-05 21:29:45 +00:00

192 lines
6.0 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#ifndef nsPIDOMWindow_h__
#define nsPIDOMWindow_h__
#include "nsISupports.h"
#include "nsIDOMLocation.h"
#include "nsIDOMXULCommandDispatcher.h"
#include "nsIDOMElement.h"
#include "nsIDOMWindowInternal.h"
#include "nsIChromeEventHandler.h"
#include "nsIDOMDocument.h"
#include "nsIURI.h"
#include "nsCOMPtr.h"
// Popup control state enum. The values in this enum must go from most
// permissive to least permissive so that it's safe to push state in
// all situations. Pushing popup state onto the stack never makes the
// current popup state less permissive (see
// GlobalWindowImpl::PushPopupControlState()).
enum PopupControlState {
openAllowed = 0, // open that window without worries
openControlled, // it's a popup, but allow it
openAbused, // it's a popup. disallow it, but allow domain override.
openOverridden // disallow window open
};
class nsIDocShell;
class nsIFocusController;
struct nsTimeoutImpl;
#define NS_PIDOMWINDOW_IID \
{ 0x7e12a2d6, 0x9a2a, 0x4907, \
{ 0xab, 0x85, 0x01, 0x34, 0xe3, 0xa8, 0x1a, 0x3f } }
class nsPIDOMWindow : public nsIDOMWindowInternal
{
public:
NS_DEFINE_STATIC_IID_ACCESSOR(NS_PIDOMWINDOW_IID)
virtual nsPIDOMWindow* GetPrivateRoot() = 0;
virtual nsresult GetObjectProperty(const PRUnichar* aProperty,
nsISupports** aObject) = 0;
// This is private because activate/deactivate events are not part
// of the DOM spec.
virtual nsresult Activate() = 0;
virtual nsresult Deactivate() = 0;
nsIChromeEventHandler* GetChromeEventHandler()
{
return mChromeEventHandler;
}
PRBool HasMutationListeners(PRUint32 aMutationEventType)
{
return (mMutationBits & aMutationEventType) != 0;
}
void SetMutationListeners(PRUint32 aType) { mMutationBits |= aType; }
virtual nsIFocusController* GetRootFocusController() = 0;
// GetExtantDocument provides a backdoor to the DOM GetDocument accessor
nsIDOMDocument* GetExtantDocument() { return mDocument; }
// Internal getter/setter for the frame element, this version of the
// getter crosses chrome boundaries whereas the public scriptable
// one doesn't for security reasons.
nsIDOMElement* GetFrameElementInternal() { return mFrameElement; }
void SetFrameElementInternal(nsIDOMElement *aFrameElement)
{
mFrameElement = aFrameElement;
}
PRBool IsLoadingOrRunningTimeout() const
{
return !mIsDocumentLoaded || mRunningTimeout;
}
virtual void SetOpenerScriptURL(nsIURI* aURI) = 0;
virtual PopupControlState PushPopupControlState(PopupControlState aState) const = 0;
virtual void PopPopupControlState(PopupControlState state) const = 0;
virtual PopupControlState GetPopupControlState() const = 0;
protected:
nsCOMPtr<nsIChromeEventHandler> mChromeEventHandler; // strong
nsCOMPtr<nsIDOMDocument> mDocument; // strong
nsIDOMElement *mFrameElement; // weak
nsCOMPtr<nsIURI> mOpenerScriptURL; // strong; used to determine whether to clear scope
nsTimeoutImpl *mRunningTimeout;
PRUint32 mMutationBits;
PRBool mIsDocumentLoaded;
};
#ifdef _IMPL_NS_LAYOUT
PopupControlState
PushPopupControlState(PopupControlState aState);
void
PopPopupControlState(PopupControlState aState);
#endif
// Helper chass that helps with pushing and poping popup control
// state. Note that this class looks different from within code that's
// part of the layout library than it does in code outside the layout
// library.
class nsAutoPopupStatePusher
{
public:
#ifdef _IMPL_NS_LAYOUT
nsAutoPopupStatePusher(PopupControlState aState)
: mOldState(::PushPopupControlState(aState))
{
}
~nsAutoPopupStatePusher()
{
PopPopupControlState(mOldState);
}
#else
nsAutoPopupStatePusher(nsPIDOMWindow *aWindow, PopupControlState aState)
: mWindow(aWindow), mOldState(openAbused)
{
if (aWindow) {
mOldState = aWindow->PushPopupControlState(aState);
}
}
~nsAutoPopupStatePusher()
{
if (mWindow) {
mWindow->PopPopupControlState(mOldState);
}
}
#endif
protected:
#ifndef _IMPL_NS_LAYOUT
nsCOMPtr<nsPIDOMWindow> mWindow;
#endif
PopupControlState mOldState;
private:
// Hide so that this class can only be stack-allocated
static void* operator new(size_t /*size*/) CPP_THROW_NEW { return nsnull; }
static void operator delete(void* /*memory*/) {}
};
#endif // nsPIDOMWindow_h__