dom/public/idl/base/nsIDOMChromeWindow.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2000
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Johnny Stenback <jst@netscape.com> (original author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "domstubs.idl"
  40
  41 interface nsIBrowserDOMWindow;
  42
  43 [scriptable, uuid(77a20f5a-68ad-41d3-97ac-6ff721512908)]
  44 interface nsIDOMChromeWindow : nsISupports
  45 {
  46   const unsigned short STATE_MAXIMIZED = 1;
  47   const unsigned short STATE_MINIMIZED = 2;
  48   const unsigned short STATE_NORMAL = 3;
  49
  50   readonly attribute unsigned short              windowState;
  51
  52   /**
  53    * browserDOMWindow provides access to yet another layer of
  54    * utility functions implemented by chrome script. It will be null
  55    * for DOMWindows not corresponding to browsers.
  56    */
  57            attribute nsIBrowserDOMWindow browserDOMWindow;
  58
  59   void                      getAttention();
  60
  61   void                      getAttentionWithCycleCount(in long aCycleCount);
  62
  63   void                      setCursor(in DOMString cursor);
  64
  65   void                      maximize();
  66   void                      minimize();
  67   void                      restore();
  68 };