Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIWebBrowserChrome Interface Reference

nsIWebBrowserChrome corresponds to the top-level, outermost window containing an embedded Gecko web browser. More...

import "nsIWebBrowserChrome.idl";

Inheritance diagram for nsIWebBrowserChrome:
Inheritance graph
[legend]
Collaboration diagram for nsIWebBrowserChrome:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void setStatus (in unsigned long statusType, in wstring status)
 Called when the status text in the chrome needs to be updated.
void destroyBrowserWindow ()
 Asks the implementer to destroy the window associated with this WebBrowser object.
void sizeBrowserTo (in long aCX, in long aCY)
 Tells the chrome to size itself such that the browser will be the specified size.
void showAsModal ()
 Shows the window as a modal window.
boolean isWindowModal ()
 Is the window modal (that is, currently executing a modal loop)?
void exitModalEventLoop (in nsresult aStatus)
 Exit a modal event loop if we're in one.

Public Attributes

const unsigned long STATUS_SCRIPT = 0x00000001
const unsigned long STATUS_SCRIPT_DEFAULT = 0x00000002
const unsigned long STATUS_LINK = 0x00000003
attribute nsIWebBrowser webBrowser
 The currently loaded WebBrowser.
const unsigned long CHROME_DEFAULT = 0x00000001
 Definitions for the chrome flags.
const unsigned long CHROME_WINDOW_BORDERS = 0x00000002
const unsigned long CHROME_WINDOW_CLOSE = 0x00000004
const unsigned long CHROME_WINDOW_RESIZE = 0x00000008
const unsigned long CHROME_MENUBAR = 0x00000010
const unsigned long CHROME_TOOLBAR = 0x00000020
const unsigned long CHROME_LOCATIONBAR = 0x00000040
const unsigned long CHROME_STATUSBAR = 0x00000080
const unsigned long CHROME_PERSONAL_TOOLBAR = 0x00000100
const unsigned long CHROME_SCROLLBARS = 0x00000200
const unsigned long CHROME_TITLEBAR = 0x00000400
const unsigned long CHROME_EXTRA = 0x00000800
const unsigned long CHROME_WITH_SIZE = 0x00001000
const unsigned long CHROME_WITH_POSITION = 0x00002000
const unsigned long CHROME_WINDOW_MIN = 0x00004000
const unsigned long CHROME_WINDOW_POPUP = 0x00008000
const unsigned long CHROME_WINDOW_RAISED = 0x02000000
const unsigned long CHROME_WINDOW_LOWERED = 0x04000000
const unsigned long CHROME_CENTER_SCREEN = 0x08000000
const unsigned long CHROME_DEPENDENT = 0x10000000
const unsigned long CHROME_MODAL = 0x20000000
const unsigned long CHROME_OPENAS_DIALOG = 0x40000000
const unsigned long CHROME_OPENAS_CHROME = 0x80000000
const unsigned long CHROME_ALL = 0x00000ffe
attribute unsigned long chromeFlags
 The chrome flags for this browser chrome.

Detailed Description

nsIWebBrowserChrome corresponds to the top-level, outermost window containing an embedded Gecko web browser.

FROZEN

Definition at line 53 of file nsIWebBrowserChrome.idl.


Member Function Documentation

Asks the implementer to destroy the window associated with this WebBrowser object.

Exit a modal event loop if we're in one.

The implementation should also exit out of the loop if the window is destroyed.

Parameters:
aStatus- the result code to return from showAsModal

Is the window modal (that is, currently executing a modal loop)?

Returns:
true if it's a modal window
void nsIWebBrowserChrome::setStatus ( in unsigned long  statusType,
in wstring  status 
)

Called when the status text in the chrome needs to be updated.

Parameters:
statusTypeindicates what is setting the text
statusstatus string. null is an acceptable value meaning no status.

Shows the window as a modal window.

Returns:
(the function error code) the status value specified by in exitModalEventLoop.

Tells the chrome to size itself such that the browser will be the specified size.

Parameters:
aCXnew width of the browser
aCYnew height of the browser

Member Data Documentation

Definition at line 116 of file nsIWebBrowserChrome.idl.

Definition at line 103 of file nsIWebBrowserChrome.idl.

Definitions for the chrome flags.

Definition at line 80 of file nsIWebBrowserChrome.idl.

Definition at line 108 of file nsIWebBrowserChrome.idl.

Definition at line 91 of file nsIWebBrowserChrome.idl.

Definition at line 86 of file nsIWebBrowserChrome.idl.

Definition at line 84 of file nsIWebBrowserChrome.idl.

Definition at line 112 of file nsIWebBrowserChrome.idl.

Definition at line 114 of file nsIWebBrowserChrome.idl.

Definition at line 113 of file nsIWebBrowserChrome.idl.

Definition at line 88 of file nsIWebBrowserChrome.idl.

Definition at line 89 of file nsIWebBrowserChrome.idl.

Definition at line 87 of file nsIWebBrowserChrome.idl.

Definition at line 90 of file nsIWebBrowserChrome.idl.

Definition at line 85 of file nsIWebBrowserChrome.idl.

Definition at line 81 of file nsIWebBrowserChrome.idl.

Definition at line 82 of file nsIWebBrowserChrome.idl.

Definition at line 102 of file nsIWebBrowserChrome.idl.

Definition at line 98 of file nsIWebBrowserChrome.idl.

Definition at line 99 of file nsIWebBrowserChrome.idl.

Definition at line 101 of file nsIWebBrowserChrome.idl.

Definition at line 83 of file nsIWebBrowserChrome.idl.

Definition at line 95 of file nsIWebBrowserChrome.idl.

Definition at line 94 of file nsIWebBrowserChrome.idl.

The chrome flags for this browser chrome.

The implementation should reflect the value of this attribute by hiding or showing its chrome appropriately.

Definition at line 123 of file nsIWebBrowserChrome.idl.

Definition at line 57 of file nsIWebBrowserChrome.idl.

Definition at line 55 of file nsIWebBrowserChrome.idl.

Definition at line 56 of file nsIWebBrowserChrome.idl.

The currently loaded WebBrowser.

The browser chrome may be told to set the WebBrowser object to a new object by setting this attribute. In this case the implementer is responsible for taking the new WebBrowser object and doing any necessary initialization or setup as if it had created the WebBrowser itself. This includes positioning setting up listeners etc.

Definition at line 75 of file nsIWebBrowserChrome.idl.


The documentation for this interface was generated from the following file: