gecko-dev/xpfe/appshell/nsIXULWindow.idl
Birunthan Mohanathas 29e62c0155 Bug 1047873 - Flatten xpfe/appshell/{public,src}/ directories. r=Neil
--HG--
rename : xpfe/appshell/public/nsAppShellCID.h => xpfe/appshell/nsAppShellCID.h
rename : xpfe/appshell/src/nsAppShellFactory.cpp => xpfe/appshell/nsAppShellFactory.cpp
rename : xpfe/appshell/src/nsAppShellService.cpp => xpfe/appshell/nsAppShellService.cpp
rename : xpfe/appshell/src/nsAppShellService.h => xpfe/appshell/nsAppShellService.h
rename : xpfe/appshell/src/nsAppShellWindowEnumerator.cpp => xpfe/appshell/nsAppShellWindowEnumerator.cpp
rename : xpfe/appshell/src/nsAppShellWindowEnumerator.h => xpfe/appshell/nsAppShellWindowEnumerator.h
rename : xpfe/appshell/src/nsChromeTreeOwner.cpp => xpfe/appshell/nsChromeTreeOwner.cpp
rename : xpfe/appshell/src/nsChromeTreeOwner.h => xpfe/appshell/nsChromeTreeOwner.h
rename : xpfe/appshell/src/nsContentTreeOwner.cpp => xpfe/appshell/nsContentTreeOwner.cpp
rename : xpfe/appshell/src/nsContentTreeOwner.h => xpfe/appshell/nsContentTreeOwner.h
rename : xpfe/appshell/public/nsIAppShellService.idl => xpfe/appshell/nsIAppShellService.idl
rename : xpfe/appshell/public/nsIPopupWindowManager.idl => xpfe/appshell/nsIPopupWindowManager.idl
rename : xpfe/appshell/public/nsIWindowMediator.idl => xpfe/appshell/nsIWindowMediator.idl
rename : xpfe/appshell/public/nsIWindowMediatorListener.idl => xpfe/appshell/nsIWindowMediatorListener.idl
rename : xpfe/appshell/public/nsIXULBrowserWindow.idl => xpfe/appshell/nsIXULBrowserWindow.idl
rename : xpfe/appshell/public/nsIXULWindow.idl => xpfe/appshell/nsIXULWindow.idl
rename : xpfe/appshell/src/nsWebShellWindow.cpp => xpfe/appshell/nsWebShellWindow.cpp
rename : xpfe/appshell/src/nsWebShellWindow.h => xpfe/appshell/nsWebShellWindow.h
rename : xpfe/appshell/src/nsWindowMediator.cpp => xpfe/appshell/nsWindowMediator.cpp
rename : xpfe/appshell/src/nsWindowMediator.h => xpfe/appshell/nsWindowMediator.h
rename : xpfe/appshell/src/nsXULWindow.cpp => xpfe/appshell/nsXULWindow.cpp
rename : xpfe/appshell/src/nsXULWindow.h => xpfe/appshell/nsXULWindow.h
rename : xpfe/appshell/src/test/chrome.ini => xpfe/appshell/test/chrome.ini
rename : xpfe/appshell/src/test/test_hiddenPrivateWindow.xul => xpfe/appshell/test/test_hiddenPrivateWindow.xul
2014-08-02 13:44:23 -07:00

129 lines
4.4 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsISupports.idl"
/**
* The nsIXULWindow
*
* When the window is destroyed, it will fire a "xul-window-destroyed"
* notification through the global observer service.
*/
interface nsIDocShell;
interface nsIDocShellTreeItem;
interface nsIXULBrowserWindow;
interface nsITabParent;
[scriptable, uuid(a68a40b9-f7df-47ff-a874-2af3df7eb888)]
interface nsIXULWindow : nsISupports
{
/**
* The docshell owning the XUL for this window.
*/
readonly attribute nsIDocShell docShell;
/**
* Indicates if this window is instrinsically sized.
*/
attribute boolean intrinsicallySized;
/**
* The primary content shell.
*
* Note that this is a docshell tree item and therefore can not be assured of
* what object it is. It could be an editor, a docshell, or a browser object.
* Or down the road any other object that supports being a DocShellTreeItem
* Query accordingly to determine the capabilities.
*/
readonly attribute nsIDocShellTreeItem primaryContentShell;
/**
* The content shell specified by the supplied id.
*
* Note that this is a docshell tree item and therefore can not be assured of
* what object it is. It could be an editor, a docshell, or a browser object.
* Or down the road any other object that supports being a DocShellTreeItem
* Query accordingly to determine the capabilities.
*/
nsIDocShellTreeItem getContentShellById(in wstring ID);
/**
* Tell this window that it has picked up a child XUL window
* @param aChild the child window being added
*/
void addChildWindow(in nsIXULWindow aChild);
/**
* Tell this window that it has lost a child XUL window
* @param aChild the child window being removed
*/
void removeChildWindow(in nsIXULWindow aChild);
/**
* Move the window to a centered position.
* @param aRelative If not null, the window relative to which the window is
* moved. See aScreen parameter for details.
* @param aScreen PR_TRUE to center the window relative to the screen
* containing aRelative if aRelative is not null. If
* aRelative is null then relative to the screen of the
* opener window if it was initialized by passing it to
* nsWebShellWindow::Initialize. Failing that relative to
* the main screen.
* PR_FALSE to center it relative to aRelative itself.
* @param aAlert PR_TRUE to move the window to an alert position,
* generally centered horizontally and 1/3 down from the top.
*/
void center(in nsIXULWindow aRelative, in boolean aScreen, in boolean aAlert);
/**
* Shows the window as a modal window. That is, ensures that it is visible
* and runs a local event loop, exiting only once the window has been closed.
*/
void showModal();
const unsigned long lowestZ = 0;
const unsigned long loweredZ = 4; /* "alwaysLowered" attribute */
const unsigned long normalZ = 5;
const unsigned long raisedZ = 6; /* "alwaysRaised" attribute */
const unsigned long highestZ = 9;
attribute unsigned long zLevel;
/**
* contextFlags are from nsIWindowCreator2
*/
attribute uint32_t contextFlags;
attribute uint32_t chromeFlags;
/**
* Begin assuming |chromeFlags| don't change hereafter, and assert
* if they do change. The state change is one-way and idempotent.
*/
void assumeChromeFlagsAreFrozen();
/**
* Create a new window.
* @param aChromeFlags see nsIWebBrowserChrome
* @param aOpeningTab the TabParent that requested this new window be opened.
* Can be left null.
* @return the newly minted window
*/
nsIXULWindow createNewWindow(in int32_t aChromeFlags,
in nsITabParent aOpeningTab);
attribute nsIXULBrowserWindow XULBrowserWindow;
/**
* Back-door method to force application of chrome flags at a particular
* time. Do NOT call this unless you know what you're doing! In particular,
* calling this when this XUL window doesn't yet have a document in its
* docshell could cause problems.
*/
[noscript] void applyChromeFlags();
};