nsIWebBrowserChrome.idl
上传用户:goldcmy89
上传日期:2017-12-03
资源大小:2246k
文件大小:6k
源码类别:

PlugIns编程

开发平台:

Visual C++

  1. /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
  2.  *
  3.  * ***** BEGIN LICENSE BLOCK *****
  4.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  5.  *
  6.  * The contents of this file are subject to the Mozilla Public License Version
  7.  * 1.1 (the "License"); you may not use this file except in compliance with
  8.  * the License. You may obtain a copy of the License at
  9.  * http://www.mozilla.org/MPL/
  10.  *
  11.  * Software distributed under the License is distributed on an "AS IS" basis,
  12.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13.  * for the specific language governing rights and limitations under the
  14.  * License.
  15.  *
  16.  * The Original Code is the Mozilla browser.
  17.  *
  18.  * The Initial Developer of the Original Code is
  19.  * Netscape Communications, Inc.
  20.  * Portions created by the Initial Developer are Copyright (C) 1999
  21.  * the Initial Developer. All Rights Reserved.
  22.  *
  23.  * Contributor(s):
  24.  *   Travis Bogard <travis@netscape.com>
  25.  *
  26.  * Alternatively, the contents of this file may be used under the terms of
  27.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29.  * in which case the provisions of the GPL or the LGPL are applicable instead
  30.  * of those above. If you wish to allow use of your version of this file only
  31.  * under the terms of either the GPL or the LGPL, and not to allow others to
  32.  * use your version of this file under the terms of the MPL, indicate your
  33.  * decision by deleting the provisions above and replace them with the notice
  34.  * and other provisions required by the GPL or the LGPL. If you do not delete
  35.  * the provisions above, a recipient may use your version of this file under
  36.  * the terms of any one of the MPL, the GPL or the LGPL.
  37.  *
  38.  * ***** END LICENSE BLOCK ***** */
  39. #include "nsISupports.idl"
  40. interface nsIWebBrowser;
  41. interface nsIDocShellTreeItem;
  42. /**
  43.  * nsIWebBrowserChrome corresponds to the top-level, outermost window
  44.  * containing an embedded Gecko web browser.
  45.  *
  46.  * @status FROZEN
  47.  */
  48. [scriptable, uuid(BA434C60-9D52-11d3-AFB0-00A024FFC08C)]
  49. interface nsIWebBrowserChrome : nsISupports
  50. {
  51.     const unsigned long STATUS_SCRIPT         = 0x00000001;
  52.     const unsigned long STATUS_SCRIPT_DEFAULT = 0x00000002;
  53.     const unsigned long STATUS_LINK           = 0x00000003;
  54.     /**
  55.      * Called when the status text in the chrome needs to be updated.
  56.      * @param statusType indicates what is setting the text
  57.      * @param status status string. null is an acceptable value meaning
  58.      *               no status.
  59.      */
  60.     void setStatus(in unsigned long statusType, in wstring status);
  61.     /**
  62.      * The currently loaded WebBrowser.  The browser chrome may be
  63.      * told to set the WebBrowser object to a new object by setting this
  64.      * attribute.  In this case the implementer is responsible for taking the 
  65.      * new WebBrowser object and doing any necessary initialization or setup 
  66.      * as if it had created the WebBrowser itself.  This includes positioning
  67.      * setting up listeners etc.
  68.      */
  69.     attribute nsIWebBrowser webBrowser;
  70.     /**
  71.      * Definitions for the chrome flags
  72.      */
  73.     const unsigned long CHROME_DEFAULT          = 0x00000001;
  74.     const unsigned long CHROME_WINDOW_BORDERS   = 0x00000002;
  75.     const unsigned long CHROME_WINDOW_CLOSE     = 0x00000004;
  76.     const unsigned long CHROME_WINDOW_RESIZE    = 0x00000008;
  77.     const unsigned long CHROME_MENUBAR          = 0x00000010;
  78.     const unsigned long CHROME_TOOLBAR          = 0x00000020;
  79.     const unsigned long CHROME_LOCATIONBAR      = 0x00000040;
  80.     const unsigned long CHROME_STATUSBAR        = 0x00000080;
  81.     const unsigned long CHROME_PERSONAL_TOOLBAR = 0x00000100;
  82.     const unsigned long CHROME_SCROLLBARS       = 0x00000200;
  83.     const unsigned long CHROME_TITLEBAR         = 0x00000400;
  84.     const unsigned long CHROME_EXTRA            = 0x00000800;
  85.     
  86.     // createBrowserWindow specific flags
  87.     const unsigned long CHROME_WITH_SIZE        = 0x00001000;
  88.     const unsigned long CHROME_WITH_POSITION    = 0x00002000;
  89.     // special cases
  90.     const unsigned long CHROME_WINDOW_MIN       = 0x00004000;
  91.     const unsigned long CHROME_WINDOW_POPUP     = 0x00008000;
  92.     const unsigned long CHROME_WINDOW_RAISED    = 0x02000000;
  93.     const unsigned long CHROME_WINDOW_LOWERED   = 0x04000000;
  94.     const unsigned long CHROME_CENTER_SCREEN    = 0x08000000;
  95.     const unsigned long CHROME_DEPENDENT        = 0x10000000;
  96.     // Note: The modal style bit just affects the way the window looks and does
  97.     //       mean it's actually modal.
  98.     const unsigned long CHROME_MODAL            = 0x20000000; 
  99.     const unsigned long CHROME_OPENAS_DIALOG    = 0x40000000;
  100.     const unsigned long CHROME_OPENAS_CHROME    = 0x80000000;
  101.     
  102.     const unsigned long CHROME_ALL              = 0x00000ffe;
  103.     
  104.     /**
  105.      * The chrome flags for this browser chrome. The implementation should
  106.      * reflect the value of this attribute by hiding or showing its chrome
  107.      * appropriately.
  108.      */
  109.     attribute unsigned long chromeFlags;
  110.     /**
  111.      * Asks the implementer to destroy the window associated with this
  112.      * WebBrowser object.
  113.      */
  114.     void destroyBrowserWindow();
  115.     /**
  116.      * Tells the chrome to size itself such that the browser will be the 
  117.      * specified size.
  118.      * @param aCX new width of the browser
  119.      * @param aCY new height of the browser
  120.      */
  121.     void sizeBrowserTo(in long aCX, in long aCY);
  122.     
  123.     /**
  124.      * Shows the window as a modal window.
  125.      * @return (the function error code) the status value specified by
  126.      *         in exitModalEventLoop.
  127.      */
  128.     void showAsModal();
  129.     
  130.     /**
  131.      * Is the window modal (that is, currently executing a modal loop)?
  132.      * @return true if it's a modal window
  133.      */
  134.     boolean isWindowModal();
  135.     /**
  136.      * Exit a modal event loop if we're in one. The implementation
  137.      * should also exit out of the loop if the window is destroyed.
  138.      * @param aStatus - the result code to return from showAsModal
  139.      */
  140.     void exitModalEventLoop(in nsresult aStatus);
  141. };