Public Member Functions | Public Attributes

nsIBrowserDOMWindow Interface Reference

The C++ source has access to the browser script source through nsIBrowserDOMWindow. More...

import "nsIBrowserDOMWindow.idl";

List of all members.

Public Member Functions

nsIDOMWindow openURI (in nsIURI aURI, in nsIDOMWindow aOpener, in short aWhere, in short aContext)
 Load a URI.
boolean isTabContentWindow (in nsIDOMWindow aWindow)

Public Attributes

const short OPEN_DEFAULTWINDOW = 0
 Values for openURI's aWhere parameter.
const short OPEN_CURRENTWINDOW = 1
 Open in the "current window".
const short OPEN_NEWWINDOW = 2
 Open in a new window.
const short OPEN_NEWTAB = 3
 Open in a new content tab in the toplevel browser window corresponding to this nsIBrowserDOMWindow.
const short OPEN_EXTERNAL = 1
 Values for openURI's aContext parameter.
const short OPEN_NEW = 2
 internal open new window

Detailed Description

The C++ source has access to the browser script source through nsIBrowserDOMWindow.

It is intended to be attached to the chrome DOMWindow of a toplevel browser window (a XUL window). A DOMWindow that does not happen to be a browser chrome window will simply have no access to any such interface.


Member Function Documentation

boolean nsIBrowserDOMWindow::isTabContentWindow ( in nsIDOMWindow  aWindow  ) 
Parameters:
aWindow the window to test.
Returns:
whether the window is the main content window for any currently open tab in this toplevel browser window.
nsIDOMWindow nsIBrowserDOMWindow::openURI ( in nsIURI  aURI,
in nsIDOMWindow  aOpener,
in short  aWhere,
in short  aContext 
)

Load a URI.

Parameters:
aURI the URI to open. null is allowed. If null is passed in, no load will be done, though the window the load would have happened in will be returned.
aWhere see possible values described above.
aOpener window requesting the open (can be null).
aContext the context in which the URI is being opened. This is used only when aWhere == OPEN_DEFAULTWINDOW.
Returns:
the window into which the URI was opened.

Member Data Documentation

Open in the "current window".

If aOpener is provided, this should be the top window in aOpener's window hierarchy, but exact behavior is application-dependent. If aOpener is not provided, it's up to the application to decide what constitutes a "current window".

Values for openURI's aWhere parameter.

Do whatever the default is based on application state, user preferences, and the value of the aContext parameter to openURI.

Values for openURI's aContext parameter.

These affect the behavior of OPEN_DEFAULTWINDOW. external link (load request from another application, xremote, etc).

internal open new window

Open in a new content tab in the toplevel browser window corresponding to this nsIBrowserDOMWindow.

Open in a new window.


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