Back to index

lightning-sunbird  0.9+nobinonly
nsIWindowMediator.idl
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) 1999
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 #include "nsISupports.idl"
00039 #include "nsISimpleEnumerator.idl"
00040 
00041 %{C++
00042 #define NS_WINDOWMEDIATOR_CID \
00043 { 0x0659cb83, 0xfaad, 0x11d2, { 0x8e, 0x19, 0xb2, 0x06, 0x62, 0x0a, 0x65, 0x7c } }
00044 
00045 #define NS_WINDOWMEDIATOR_CONTRACTID \
00046   "@mozilla.org/appshell/window-mediator;1"
00047 %}
00048 
00049 interface nsIXULWindow;
00050 interface nsIWidget;
00051 interface nsIDOMWindowInternal;
00052 interface nsIWindowMediatorListener;
00053 
00054 [scriptable, uuid(0659cb81-faad-11d2-8e19-b206620a657c)]
00055 interface nsIWindowMediator: nsISupports
00056 {
00065   nsISimpleEnumerator getEnumerator(in wstring aWindowType);
00066 
00070   nsISimpleEnumerator getXULWindowEnumerator(in wstring aWindowType);
00071 
00084   nsISimpleEnumerator getZOrderDOMWindowEnumerator(in wstring aWindowType,
00085                         in boolean aFrontToBack);
00086 
00090   nsISimpleEnumerator getZOrderXULWindowEnumerator(in wstring aWindowType,
00091                         in boolean aFrontToBack);
00092 
00101   nsIDOMWindowInternal getMostRecentWindow(in wstring aWindowType);
00102 
00107   [noscript] void registerWindow(in nsIXULWindow aWindow);
00108 
00113   [noscript] void unregisterWindow(in nsIXULWindow aWindow);
00114 
00120   [noscript] void updateWindowTimeStamp(in nsIXULWindow aWindow);
00121 
00127   [noscript] void updateWindowTitle(in nsIXULWindow aWindow,
00128                                     in wstring inTitle );
00129 
00130   /* z-ordering: */
00131 
00132   const unsigned long zLevelTop    = 1;
00133   const unsigned long zLevelBottom = 2;
00134   const unsigned long zLevelBelow  = 3; // below some window
00135 
00166   [noscript] boolean calculateZPosition(in nsIXULWindow   inWindow,
00167                                         in unsigned long  inPosition,
00168                                         in nsIWidget      inBelow,
00169                                         out unsigned long outPosition,
00170                                         out nsIWidget     outBelow);
00171 
00181   [noscript] void setZPosition(in nsIXULWindow inWindow,
00182                                in unsigned long inPosition,
00183                                in nsIXULWindow inBelow);
00184 
00189   [noscript] PRUint32 getZLevel(in nsIXULWindow aWindow);
00190 
00198   [noscript] void setZLevel(in nsIXULWindow aWindow, in PRUint32 aZLevel);
00199 
00204   void addListener(in nsIWindowMediatorListener aListener);
00205 
00209   void removeListener(in nsIWindowMediatorListener aListener);
00210 };