Readonly activeRetrieves the active window from the focus manager.
Optional aInstancePtr: objectA run time mechanism for interface discovery.
NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.
aInstancePtr must not be null.
[in] A requested interface IID
[out] A pointer to an interface pointer to receive the result.
Retrieve the chrome window mapped to the given DOM window. Window Watcher keeps a list of all top-level DOM windows currently open, along with their corresponding chrome interfaces. Since DOM Windows lack a (public) means of retrieving their corresponding chrome, this method will do that.
the corresponding chrome window
the DOM window whose chrome window the caller needs
Retrieve an existing chrome window (or frame).
the window name
Note: This method will not consider special names like "_blank", "_top", "_self", or "_parent", as there is no reference window.
Note: This method will search all open windows for any window or frame with the given window name. Make sure you understand the security implications of this before using this method!
Get an iterator for currently open windows in the order they were opened, guaranteeing that each will be visited exactly once.
an enumerator which will itself return nsISupports objects which can be QIed to an nsIDOMWindow
Create a new window. It will automatically be added to our list (via addWindow()).
the new window
This method may examine the JS context stack for purposes of determining the security context to use for the search for a given window named aName.
This method should try to set the default charset for the new window to the default charset of aParent. This is not guaranteed, however.
This method may dispatch a "toplevel-window-ready" notification via nsIObserverService if the window did not already exist.
parent window, if any. Null if no parent. If it is impossible to get to an nsIWebBrowserChrome from aParent, this method will effectively act as if aParent were null.
window name from JS window.open. can be null. If a window with this name already exists, the openWindow call may just load aUrl in it (if aUrl is not null) and return it.
window features from JS window.open. can be null.
extra argument(s) to the new window, to be attached as the |arguments| property. An nsIArray will be unwound into multiple arguments (but not recursively!). can be null.
Clients of this service can register themselves to be notified when a window is opened or closed (added to or removed from this service). This method adds an aObserver to the list of objects to be notified.
the object to be notified when windows are opened or closed. Its Observe method will be called with the following parameters:
aObserver::Observe interprets its parameters so: aSubject the window being opened or closed, sent as an nsISupports which can be QIed to an nsIDOMWindow. aTopic a wstring, either "domwindowopened" or "domwindowclosed". someData not used.
Set the window creator callback. It must be filled in by the app. openWindow will use it to create new windows.
the callback. if null, the callback will be cleared and window creation capabilities lost.
Clients of this service can register themselves to be notified when a window is opened or closed (added to or removed from this service). This method removes an aObserver from the list of objects to be notified.
the observer to be removed.
Generated using TypeDoc
nsIWindowWatcher is the keeper of Gecko/DOM Windows. It maintains a list of open top-level windows, and allows some operations on them. Usage notes: This component has an |activeWindow| property. Clients may expect this property to be always current, so to properly integrate this component the application will need to keep it current by setting the property as the active window changes. This component should not keep a (XPCOM) reference to any windows; the implementation will claim no ownership. Windows must notify this component when they are created or destroyed, so only a weak reference is kept. Note that there is no interface for such notifications (not a public one, anyway). This is taken care of both in Mozilla and by common embedding code. Embedding clients need do nothing special about that requirement. This component must be initialized at application startup by calling setWindowCreator.