Songbird / Development / Songbird Add-Ons API Documentation

sbIPrompter Interface Reference

import "sbIPrompter.idl";

List of all members.

Public Member Functions

nsIDOMWindow openDialog (in nsIDOMWindow aParent, in DOMString aUrl, in DOMString aName, in DOMString aOptions, in nsISupports aExtraArgument)

Public Attributes

attribute AString parentWindowType
attribute boolean waitForWindow


Detailed Description

The sbIPrompter interface provides an nsIPromptService to environments without a default window (e.g., XPCOM components). For all methods that take a parent window as an argument, the parent may be set to null. This interface allows a parent window type to be set to be used as the parent window in these cases. In addition, the sbIPrompter interface can be set to wait for a parent window to be available before calling the nsIPromptService methods. If the parent window type is not available and wait for window is false, dialogs are opened with the currently active window as the parent. A window is not considered to be available until after its overlays have loaded. If a method is called from a non-main thread, and wait for window is set, and a window is not available, the method will wait for a window to become available. If a method is called from the main thread, and wait for window is set, and a window is not available, the method will return NS_ERROR_NOT_AVAILABLE. If any error occurs, the method will return NS_ERROR_FAILURE.

"@songbirdnest.com/Songbird/Prompter;1" Use create instance with this component. No default parent window type is set and the default waitForWindow is false.

Definition at line 59 of file sbIPrompter.idl.


Member Function Documentation

nsIDOMWindow sbIPrompter::openDialog ( in nsIDOMWindow  aParent,
in DOMString  aUrl,
in DOMString  aName,
in DOMString  aOptions,
in nsISupports  aExtraArgument 
)

Open a dialog window with with the chrome URL specified by aUrl and parent specified by aParent. The window name is specified by aName and the window options are specified by aOptions. Additional window arguments may be provided in aExtraArguments.

Parameters:
aParent Parent window.
aUrl URL of window chrome.
aName Window name.
aOptions Window options.
aExtraArguments Extra window arguments.


Member Data Documentation

attribute AString sbIPrompter::parentWindowType

The parent window type.

Definition at line 64 of file sbIPrompter.idl.

attribute boolean sbIPrompter::waitForWindow

If true, wait for a parent window of the configured type to be available before prompting.

Definition at line 70 of file sbIPrompter.idl.


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:29:01 2009 for Songbird by  doxygen 1.5.2