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.
Puts up an alert dialog with an OK button.
The parent window or null.
Text to appear in the title of the dialog.
Text to appear in the body of the dialog.
Like alert, but with a BrowsingContext as parent.
The browsing context the prompt should be opened for.
Whether the prompt should be window, tab or content modal.
Puts up an alert dialog with an OK button and a labeled checkbox.
The parent window or null.
Text to appear in the title of the dialog.
Text to appear in the body of the dialog.
Text to appear with the checkbox.
Contains the initial checked state of the checkbox when this method is called and the final checked state after this method returns.
Like alertCheck, but with a BrowsingContext as parent.
The browsing context the prompt should be opened for.
Whether the prompt should be window, tab or content modal.
Async version of alertBC
A promise which resolves when the prompt is dismissed.
Async version of alertCheckBC
A promise which resolves when the prompt is dismissed.
nsIPropertyBag { checked: boolean }
Async version of confirmBC
A promise which resolves when the prompt is dismissed.
nsIPropertyBag { ok: boolean }
Async version of confirmCheckBC
A promise which resolves when the prompt is dismissed.
nsIPropertyBag { ok: boolean, checked: boolean }
Async version of confirmExBC
A promise which resolves when the prompt is dismissed.
nsIPropertyBag { checked: boolean, buttonNumClicked: int }
Async version of promptBC
A promise which resolves when the prompt is dismissed.
nsIPropertyBag { checked: boolean, value: string, ok: boolean }
Async version of promptAuthBC
A promise which resolves when the prompt is dismissed.
nsIPropertyBag { ok: boolean }
Async version of promptPasswordBC
A promise which resolves when the prompt is dismissed.
nsIPropertyBag { pass: string, ok: boolean }
Async version of promptUsernameAndPasswordBC
A promise which resolves when the prompt is dismissed.
nsIPropertyBag { user: string, pass: string, ok: boolean }
Async version of selectBC
A promise which resolves when the prompt is dismissed.
nsIPropertyBag { selected: int, ok: boolean }
Puts up a dialog with OK and Cancel buttons.
true for OK, false for Cancel
The parent window or null.
Text to appear in the title of the dialog.
Text to appear in the body of the dialog.
Like confirm, but with a BrowsingContext as parent.
The browsing context the prompt should be opened for.
Whether the prompt should be window, tab or content modal.
Puts up a dialog with OK and Cancel buttons and a labeled checkbox.
true for OK, false for Cancel
The parent window or null.
Text to appear in the title of the dialog.
Text to appear in the body of the dialog.
Text to appear with the checkbox.
Contains the initial checked state of the checkbox when this method is called and the final checked state after this method returns.
Like confirmCheck, but with a BrowsingContext as parent.
The browsing context the prompt should be opened for.
Whether the prompt should be window, tab or content modal.
Puts up a dialog with up to 3 buttons and an optional, labeled checkbox.
index of the button pressed.
Buttons are numbered 0 - 2. The implementation can decide whether the sequence goes from right to left or left to right. Button 0 is the default button unless one of the Button Default Flags is specified.
A button may use a predefined title, specified by one of the Button Title Flags values. Each title value can be multiplied by a position value to assign the title to a particular button. If BUTTON_TITLE_IS_STRING is used for a button, the string parameter for that button will be used. If the value for a button position is zero, the button will not be shown.
In general, aButtonFlags is constructed per the following example:
aButtonFlags = (BUTTON_POS_0) * (BUTTON_TITLE_AAA) + (BUTTON_POS_1) * (BUTTON_TITLE_BBB) + BUTTON_POS_1_DEFAULT;
where "AAA" and "BBB" correspond to one of the button titles.
The parent window or null.
Text to appear in the title of the dialog.
Text to appear in the body of the dialog.
A combination of Button Flags.
Used when button 0 uses TITLE_IS_STRING
Used when button 1 uses TITLE_IS_STRING
Used when button 2 uses TITLE_IS_STRING
Text to appear with the checkbox. Null if no checkbox.
Contains the initial checked state of the checkbox when this method is called and the final checked state after this method returns.
Like confirmEx, but with a BrowsingContext as parent.
The browsing context the prompt should be opened for.
Whether the prompt should be window, tab or content modal.
Puts up a dialog with an edit field and an optional, labeled checkbox.
true for OK, false for Cancel.
The parent window or null.
Text to appear in the title of the dialog.
Text to appear in the body of the dialog.
Contains the default value for the dialog field when this method is called (null value is ok). Upon return, if the user pressed OK, then this parameter contains a newly allocated string value. Otherwise, the parameter's value is unmodified.
Text to appear with the checkbox. If null, check box will not be shown.
Contains the initial checked state of the checkbox when this method is called and the final checked state after this method returns.
Like promptAuth, but with a BrowsingContext as parent.
The browsing context the prompt should be opened for.
Whether the prompt should be window, tab or content modal.
Like prompt, but with a BrowsingContext as parent.
The browsing context the prompt should be opened for.
Whether the prompt should be window, tab or content modal.
Puts up a dialog with a password field.
true for OK, false for Cancel.
The parent window or null.
Text to appear in the title of the dialog.
Text to appear in the body of the dialog.
Contains the default value for the password field when this method is called (null value is ok). Upon return, if the user pressed OK, then this parameter contains a newly allocated string value. Otherwise, the parameter's value is unmodified.
Like promptPassword, but with a BrowsingContext as parent.
The browsing context the prompt should be opened for.
Whether the prompt should be window, tab or content modal.
Puts up a dialog with an edit field and a password field.
true for OK, false for Cancel.
The parent window or null.
Text to appear in the title of the dialog.
Text to appear in the body of the dialog.
Contains the default value for the username field when this method is called (null value is ok). Upon return, if the user pressed OK, then this parameter contains a newly allocated string value. Otherwise, the parameter's value is unmodified.
Contains the default value for the password field when this method is called (null value is ok). Upon return, if the user pressed OK, then this parameter contains a newly allocated string value. Otherwise, the parameter's value is unmodified.
Like promptUsernameAndPassword, but with a BrowsingContext as parent.
The browsing context the prompt should be opened for.
Whether the prompt should be window, tab or content modal.
Puts up a dialog box which has a list box of strings from which the user may make a single selection.
true for OK, false for Cancel.
The parent window or null.
Text to appear in the title of the dialog.
Text to appear in the body of the dialog.
The list of strings to display.
Contains the index of the selected item in the list when this method returns true.
Like select, but with a BrowsingContext as parent.
The browsing context the prompt should be opened for.
Whether the prompt should be window, tab or content modal.
Generated using TypeDoc
This is the interface to the embeddable prompt service; the service that implements nsIPrompt. Its interface is designed to be just nsIPrompt, each method modified to take a parent window parameter.
Accesskeys can be attached to buttons and checkboxes by inserting an & before the accesskey character in the checkbox message or button title. For a real &, use && instead. (A "button title" generally refers to the text label of a button.)
One note: in all cases, the parent window parameter can be null. However, these windows are all intended to have parents. So when no parent is specified, the implementation should try hard to find a suitable foster parent.
Implementations are free to choose how they present the various button types. For example, while prompts that give the user a choice between OK and Cancel are required to return a boolean value indicating whether or not the user accepted the prompt (pressed OK) or rejected the prompt (pressed Cancel), the implementation of this interface could very well speak the prompt to the user instead of rendering any visual user-interface. The standard button types are merely idioms used to convey the nature of the choice the user is to make.
Because implementations of this interface may loosely interpret the various button types, it is advised that text messages passed to these prompts do not refer to the button types by name. For example, it is inadvisable to tell the user to "Press OK to proceed." Instead, such a prompt might be rewritten to ask the user: "Would you like to proceed?"