toolkit/components/browser/nsIWebBrowserChrome.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "nsISupports.idl"
   8 #include "nsIBaseWindow.idl"
   9
  10 interface nsIWebBrowser;
  11 interface nsIDocShellTreeItem;
  12
  13 /**
  14  * nsIWebBrowserChrome corresponds to the top-level, outermost window
  15  * containing an embedded Gecko web browser.
  16  */
  17
  18 [scriptable, uuid(E8C414C4-DC38-4BA3-AB4E-EC4CBBE22907)]
  19 interface nsIWebBrowserChrome : nsISupports
  20 {
  21     /**
  22      * Called when the link hover status is being changed.
  23      * @param status status string. empty string is an acceptable value
  24      *               meaning no link is hovered.
  25      */
  26     void setLinkStatus(in AString status);
  27
  28     /**
  29      * Definitions for the chrome flags
  30      */
  31     const unsigned long CHROME_DEFAULT                = 1 << 0;
  32     const unsigned long CHROME_WINDOW_BORDERS         = 1 << 1;
  33     const unsigned long CHROME_WINDOW_CLOSE           = 1 << 2;
  34     const unsigned long CHROME_WINDOW_RESIZE          = 1 << 3;
  35     const unsigned long CHROME_MENUBAR                = 1 << 4;
  36     const unsigned long CHROME_TOOLBAR                = 1 << 5;
  37     const unsigned long CHROME_LOCATIONBAR            = 1 << 6;
  38     const unsigned long CHROME_STATUSBAR              = 1 << 7;
  39     const unsigned long CHROME_PERSONAL_TOOLBAR       = 1 << 8;
  40     const unsigned long CHROME_SCROLLBARS             = 1 << 9;
  41     const unsigned long CHROME_TITLEBAR               = 1 << 10;
  42     const unsigned long CHROME_EXTRA                  = 1 << 11;
  43
  44     // Free bits here.
  45     const unsigned long CHROME_ALL =
  46         CHROME_WINDOW_BORDERS | CHROME_WINDOW_CLOSE | CHROME_WINDOW_RESIZE |
  47         CHROME_MENUBAR | CHROME_TOOLBAR | CHROME_LOCATIONBAR |
  48         CHROME_STATUSBAR | CHROME_PERSONAL_TOOLBAR | CHROME_SCROLLBARS |
  49         CHROME_TITLEBAR | CHROME_EXTRA;
  50
  51     const unsigned long CHROME_WINDOW_MINIMIZE        = 1 << 14;
  52
  53     const unsigned long CHROME_ALERT                  = 1 << 15;
  54
  55     // whether to open a new private window.  CHROME_NON_PRIVATE_WINDOW
  56     // forces the opened window to be non-private, and overrides
  57     // CHROME_PRIVATE_WINDOW if it's set.  CHROME_PRIVATE_WINDOW
  58     // forces the opened window to be private.  If neither of these
  59     // flags are specified, the opened window will inherit the privacy
  60     // status of its opener.  If there is no opener window, the new
  61     // window will be non-private.
  62     //
  63     // CHROME_PRIVATE_LIFETIME causes the docshell to affect private-browsing
  64     // session lifetime.  This flag is currently respected only for remote
  65     // docshells.
  66     const unsigned long CHROME_PRIVATE_WINDOW         = 1 << 16;
  67     const unsigned long CHROME_NON_PRIVATE_WINDOW     = 1 << 17;
  68     const unsigned long CHROME_PRIVATE_LIFETIME       = 1 << 18;
  69     const unsigned long CHROME_ALWAYS_ON_TOP          = 1 << 19;
  70
  71     // Whether this window should use remote (out-of-process) tabs.
  72     const unsigned long CHROME_REMOTE_WINDOW          = 1 << 20;
  73
  74     // Whether this window should use out-of-process cross-origin subframes.
  75     const unsigned long CHROME_FISSION_WINDOW         = 1 << 21;
  76
  77     // Prevents new window animations on MacOS and Windows. Currently
  78     // ignored for Linux.
  79     const unsigned long CHROME_SUPPRESS_ANIMATION     = 1 << 24;
  80
  81     const unsigned long CHROME_WINDOW_RAISED          = 1 << 25;
  82     const unsigned long CHROME_WINDOW_LOWERED         = 1 << 26;
  83     const unsigned long CHROME_CENTER_SCREEN          = 1 << 27;
  84
  85     // Make the new window dependent on the parent.  This flag is only
  86     // meaningful if CHROME_OPENAS_CHROME is set; content windows should not be
  87     // dependent.
  88     const unsigned long CHROME_DEPENDENT              = 1 << 28;
  89
  90     // Note: The modal style bit just affects the way the window looks and does
  91     //       mean it's actually modal.
  92     const unsigned long CHROME_MODAL                  = 1 << 29;
  93     const unsigned long CHROME_OPENAS_DIALOG          = 1 << 30;
  94     const unsigned long CHROME_OPENAS_CHROME          = 1 << 31;
  95
  96     const unsigned long CHROME_MINIMAL_POPUP =
  97       CHROME_WINDOW_BORDERS | CHROME_WINDOW_CLOSE | CHROME_WINDOW_RESIZE |
  98       CHROME_WINDOW_MINIMIZE | CHROME_LOCATIONBAR | CHROME_STATUSBAR |
  99       CHROME_SCROLLBARS | CHROME_TITLEBAR;
 100
 101     /**
 102      * The chrome flags for this browser chrome. The implementation should
 103      * reflect the value of this attribute by hiding or showing its chrome
 104      * appropriately.
 105      */
 106     attribute unsigned long chromeFlags;
 107
 108     /**
 109      * Shows the window as a modal window.
 110      */
 111     void showAsModal();
 112
 113     /**
 114      * Is the window modal (that is, currently executing a modal loop)?
 115      * @return true if it's a modal window
 116      */
 117     boolean isWindowModal();
 118
 119     /**
 120      * Allows to request the change of individual dimensions of a window
 121      * without specifying all dimensions.
 122      *
 123      * Gets called as fallback when no nsIBaseWindow is available.
 124      *
 125      * @see nsIBaseWindow
 126      */
 127     void setDimensions(in DimensionRequest aRequest);
 128
 129     /**
 130      * Gets the dimensions of the window. The caller may pass
 131      * <CODE>nullptr</CODE> for any value it is uninterested in receiving.
 132      *
 133      * Gets called as fallback when no nsIBaseWindow is available.
 134      *
 135      * @see nsIBaseWindow
 136      */
 137     void getDimensions(in DimensionKind aDimensionKind, out long aX, out long aY, out long aCX, out long aCY);
 138
 139     /**
 140      * Blur the window. This should unfocus the window and send an onblur event.
 141      */
 142     void blur();
 143 };