Subclasses
Attributes
From nsICommandHandlerInit
From nsICommandLine
A window to be targeted by this command line. In most cases, this will be null (xremote will sometimes set this attribute).
From nsIDOMJSWindow
window.frames in Netscape 4.x and IE is just a reference to the window itself (i.e. window.frames === window), but this doesn't make sense from a generic API point of view so that's why this is JS specific. This property is "replaceable" in JavaScript.
From nsIDOMMessageEvent
The window which originated this event.
From nsIDOMNSHTMLFrameElement
From nsIDOMPopupBlockedEvent
The window object that attempted to open the blocked popup (i.e. the window object on which open() was called).
From nsIDOMWindow
Accessor for this window's parent window, or the window itself if there is no parent, or if the parent is of different type (i.e. this does not cross chrome-content boundaries).
Accessor for the root of this hierarchy of windows. This root may be the window itself if there is no parent, or if the parent is of different type (i.e. this does not cross chrome-content boundaries). This property is "replaceable" in JavaScript */
From nsIDOMWindowInternal
From nsIDOMXULCommandDispatcher
From nsIGeolocationRequest
From nsILoadContext
associatedWindow is the window with which the load is associated, if any. Note that the load may be triggered by a document which is different from the document in associatedWindow, and in fact the source of the load need not be same-origin with the document in associatedWindow. This attribute may be null if there is no associated window.
topWindow is the top window which is of same type as associatedWindow. This is equivalent to associatedWindow.top, but is provided here as a convenience. All the same caveats as associatedWindow of apply, of course. This attribute may be null if there is no associated window.
From nsITypeAheadFind
From nsIWebBrowser
The top-level DOM window. The embedder may walk the entire DOM starting from this value. @see nsIDOMWindow
From nsIWebBrowserFindInFrames
currentSearchFrame Frame at which to start the search. Once the search is done, this will be set to be the last frame searched, whether or not a result was found. Has to be equal to or contained within the rootSearchFrame.
rootSearchFrame Frame within which to confine the search (normally the content area frame). Set this to only search a subtree of the frame hierarchy.
From nsIWebBrowserFocus
The currently focused nsDOMWindow when the browser is active, or the last focused nsDOMWindow when the browser is inactive.
From nsIWebBrowserPrint
Returns a pointer to the current child DOMWindow that is being print previewed. (FrameSet Frames) Returns null if parent document is not a frameset or the entire FrameSet document is being print previewed This enables any consumers of the interface to have access to the "current" child DOMWindow at later points in the execution
From nsIWebProgress
The DOM window associated with this nsIWebProgress instance.
@throw NS_ERROR_FAILURE
Indicates that there is no associated DOM window.
From nsIWindowWatcher
The Watcher serves as a global storage facility for the current active
(frontmost non-floating-palette-type) window, storing and returning
it on demand. Users must keep this attribute current, including after
the topmost window is closed. This attribute obviously can return null
if no windows are open, but should otherwise always return a valid
window.
Returns
From nsIBrowserDOMWindow
Load a URI
@param 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.
@param aWhere see possible values described above.
@param aOpener window requesting the open (can be null).
@param aContext the context in which the URI is being opened. This
is used only when aWhere == OPEN_DEFAULTWINDOW.
@return the window into which the URI was opened.
From nsIBrowserGlue
Gets the most recent window that's a browser (but not a popup)
From nsIDOMJSWindow
This is the scriptable version of nsIDOMWindowInternal::open() that takes 3 optional arguments. Its binary name is OpenJS to avoid colliding with nsIDOMWindowInternal::open(), which has the same signature. The reason we can't have that collision is that the implementation needs to know whether it was called from JS or not. IOW, DO NOT CALL THIS FROM C++
[binaryname(OpenJS)]
nsIDOMWindow
open([optional] in DOMString url, [optional] in DOMString name, [optional] in DOMString options)
This is the scriptable version of nsIDOMWindowInternal::openDialog() that takes 3 optional arguments, plus any additional arguments are passed on as arguments on the dialog's window object (window.arguments).
nsIDOMWindow
openDialog([optional] in DOMString url, [optional] in DOMString name, [optional] in DOMString options)
From nsIDOMWindowCollection
Method for accessing an item in this collection by index.
Method for accessing an item in this collection by window name.
From nsIDOMWindowInternal
Open a new window with this one as the parent. This method will NOT examine the JS stack for purposes of determining a caller. This window will be used for security checks during the search by name and the default character set on the newly opened window will just be the default character set of this window.
This method works like open except that aExtraArgument gets converted into the array window.arguments in JS, if aExtraArgument is a nsISupportsArray then the individual items in the array are inserted into window.arguments, and primitive nsISupports (nsISupportsPrimitives) types are converted to native JS types when possible.
[noscript]
nsIDOMWindow
openDialog(in DOMString url, in DOMString name, in DOMString options, in nsISupports aExtraArgument)
From nsISessionStore_MOZILLA_1_9_1
@param aIndex is the index of the windows to be restored (FIFO ordered). @returns the nsIDOMWindow object of the reopened window
From nsIWindowProvider
A method to request that this provider provide a window. The window
returned need not to have the right name or parent set on it; setting
those is the caller's responsibility. The provider can always return null
to have the caller create a brand-new window.
@param aParent Must not be null. This is the window that the caller wants
to use as the parent for the new window. Generally,
nsIWindowProvider implementors can expect to be somehow
related to aParent; the relationship may depend on the
nsIWindowProvider implementation.
@param aChromeFlags The chrome flags the caller will use to create a new
window if this provider returns null. See
nsIWebBrowserChrome for the possible values of this
field.
@param aPositionSpecified Whether the attempt to create a window is trying
to specify a position for the new window.
@param aSizeSpecified Whether the attempt to create a window is trying to
specify a size for the new window.
@param aURI The URI to be loaded in the new window. The nsIWindowProvider
implementation MUST NOT load this URI in the window it
returns. This URI is provided solely to help the
nsIWindowProvider implenentation make decisions; the caller
will handle loading the URI in the window returned if
provideWindow returns a window. Note that the URI may be null
if the load cannot be represented by a single URI (e.g. if
the load has extra load flags, POST data, etc).
@param aName The name of the window being opened. Setting the name on the
return value of provideWindow will be handled by the caller;
aName is provided solely to help the nsIWindowProvider
implementation make decisions.
@param aFeatures The feature string for the window being opened. This may
be empty. The nsIWindowProvider implementation is
allowed to apply the feature string to the window it
returns in any way it sees fit. See the nsIWindowWatcher
interface for details on feature strings.
@param aWindowIsNew [out] Whether the window being returned was just
created by the window provider implementation.
This can be used by callers to keep track of which
windows were opened by the user as opposed to
being opened programmatically. This should be set
to false if the window being returned existed
before the provideWindow() call. The value of this
out parameter is meaningless if provideWindow()
returns null.
@return A window the caller should use or null if the caller should just
create a new window. The returned window may be newly opened by
the nsIWindowProvider implementation or may be a window that
already existed.
@see nsIWindowWatcher for more information on aFeatures.
@see nsIWebBrowserChrome for more information on aChromeFlags.
nsIDOMWindow
provideWindow(in nsIDOMWindow aParent, in unsigned long aChromeFlags, in boolean aPositionSpecified, in boolean aSizeSpecified, in nsIURI aURI, in AString aName, in AUTF8String aFeatures, out boolean aWindowIsNew)
From nsIWindowWatcher
Retrieve an existing window (or frame).
@param aTargetName the window name
@param aCurrentWindow a starting point in the window hierarchy to
begin the search. If null, each toplevel window
will be searched.
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!
Create a new window. It will automatically be added to our list
(via addWindow()).
@param aParent 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.
@param aURL url to which to open the new window. Must already be
escaped, if applicable. can be null.
@param aName 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.
@param aFeatures window features from JS window.open. can be null.
@param aArguments extra argument(s) to the new window, to be attached
as the |arguments| property. An nsISupportsArray will be
unwound into multiple arguments (but not recursively!).
can be null.
@return the new window
@note 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.
@note This method should try to set the default charset for the new
window to the default charset of aParent. This is not guaranteed,
however.
@note This method may dispatch a "toplevel-window-ready" notification
via nsIObserverService if the window did not already exist.
nsIDOMWindow
openWindow(in nsIDOMWindow aParent, in string aUrl, in string aName, in string aFeatures, in nsISupports aArguments)
From nsPIWindowWatcher
Like the public interface's open(), but can deal with openDialog
style arguments.
@param aParent 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.
@param aURL url to which to open the new window. Must already be
escaped, if applicable. can be null.
@param aName 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.
@param aFeatures window features from JS window.open. can be null.
@param aDialog use dialog defaults (see nsIDOMWindowInternal::openDialog)
@param aArgs Window argument
@return the new window
@note 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.
@note This method should try to set the default charset for the new
window to the default charset of the document in the calling window
(which is determined based on the JS stack and the value of
aParent). This is not guaranteed, however.
nsIDOMWindow
openWindowJS(in nsIDOMWindow aParent, in string aUrl, in string aName, in string aFeatures, in boolean aDialog, in nsIArray aArgs)
Parameters
From nsIBrowserDOMWindow
Load a URI
@param 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.
@param aWhere see possible values described above.
@param aOpener window requesting the open (can be null).
@param aContext the context in which the URI is being opened. This
is used only when aWhere == OPEN_DEFAULTWINDOW.
@return the window into which the URI was opened.
@param aWindow the window to test.
@return whether the window is the main content window for any
currently open tab in this toplevel browser window.
From nsIBrowserGlue
Deletes privacy sensitive data according to user preferences
@param aParentWindow an optionally null window which is the parent of the
sanitization dialog
From nsICommandLineRunner
Set the windowContext parameter.
From nsICommandManager
void
doCommand(in string aCommandName, in nsICommandParams aCommandParams, in nsIDOMWindow aTargetWindow)
void
getCommandState(in string aCommandName, in nsIDOMWindow aTargetWindow, in nsICommandParams aCommandParams)
From nsICookiePromptService
long
cookieDialog(in nsIDOMWindow parent, in nsICookie cookie, in ACString hostname, in long cookiesFromHost, in boolean changingCookie, out boolean rememberDecision)
From nsIDOMCanvasRenderingContext2D
Renders a region of a window into the canvas. The contents of the window's viewport are rendered, ignoring viewport clipping and scrolling. @param x @param y @param w @param h specify the area of the window to render, in CSS pixels. @param backgroundColor the canvas is filled with this color before we render the window into it. This color may be transparent/translucent. It is given as a CSS color string (e.g., rgb() or rgba()). @param flags Uused to better control the drawWindow call. Flags can be ORed together. Of course, the rendering obeys the current scale, transform and globalAlpha values. Hints: -- If 'rgba(0,0,0,0)' is used for the background color, the drawing will be transparent wherever the window is transparent. -- Top-level browsed documents are usually not transparent because the user's background-color preference is applied, but IFRAMEs are transparent if the page doesn't set a background. -- If an opaque color is used for the background color, rendering will be faster because we won't have to compute the window's transparency. This API cannot currently be used by Web content. It is chrome only.
void
drawWindow(in nsIDOMWindow window, in long x, in long y, in long w, in long h, in DOMString bgColor, [optional] in unsigned long flags)
From nsIDOMMessageEvent
Initializes this event with the given data, in a manner analogous to the similarly-named method on the nsIDOMEvent interface, also setting the data, origin, source, and lastEventId attributes of this appropriately.
void
initMessageEvent(in DOMString aType, in boolean aCanBubble, in boolean aCancelable, in DOMString aData, in DOMString aOrigin, in DOMString aLastEventId, in nsIDOMWindow aSource)
Initializes this event with the given data, in a manner analogous to the similarly-named method on the Event interface, also setting the data, origin, source, and lastEventId attributes of this appropriately.
void
initMessageEventNS(in DOMString aNamespaceURI, in DOMString aType, in boolean aCanBubble, in boolean aCancelable, in DOMString aData, in DOMString aOrigin, in DOMString aLastEventId, in nsIDOMWindow aSource)
From nsIDOMPopupBlockedEvent
void
initPopupBlockedEvent(in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in nsIDOMWindow requestingWindow, in nsIURI popupWindowURI, in DOMString popupWindowName, in DOMString popupWindowFeatures)
From nsIEditingSession
Removes all the editor's controllers/listeners etc and makes the window uneditable.
Disable scripts and plugins in aWindow.
Undos detachFromWindow(), reattaches this editing session/editor to the window.
Restore JS and plugins (enable/disable them) according to the state they were before the last call to disableJSAndPlugins.
Get the editor for this window. May return null
Make this window editable
@param aWindow nsIDOMWindow, the window the embedder needs to make editable
@param aEditorType string, "html" "htmlsimple" "text" "textsimple"
@param aMakeWholeDocumentEditable if PR_TRUE make the whole document in
aWindow editable, otherwise it's the
embedder who should make the document
(or part of it) editable.
@param aInteractive if PR_FALSE turn off scripting and plugins
void
makeWindowEditable(in nsIDOMWindow window, in string aEditorType, in boolean doAfterUriLoad, in boolean aMakeWholeDocumentEditable, in boolean aInteractive)
Setup editor and related support objects
Destroy editor and related support objects
Test whether a specific window has had its editable flag set; it may have an editor now, or will get one after the uri load. Use this, passing the content root window, to test if we've set up editing for this content.
From nsIFeedWriter
Initializes the feed writer and loads the feed subscription UI.
@param aWindow
The DOMWindow of the preview page.
window.location.href == the URI of the feed.
From nsIFilePicker
Initialize the file picker widget. The file picker is not valid until this
method is called.
@param parent nsIDOMWindow parent. This dialog will be dependent
on this parent. parent must be non-null.
@param title The title for the file widget
@param mode load, save, or get folder
From nsILoginManagerPrompter
Initialize the prompter. Must be called before using other interfaces.
@param aWindow
The in which the user is doing some login-related action that's
resulting in a need to prompt them for something. The prompt
will be associated with this window (or, if a notification bar
is being used, topmost opener in some cases).
From nsINonBlockingAlertService
This shows a non-blocking alert with the specified title and
message text. This function requires a valid parent window with
which the alert is associated.
@param aParent
The parent window. This must not be null.
@param aDialogTitle
Text to appear in the title of the alert.
@param aText
Text to appear in the body of the alert.
From nsIPrintingPromptService
Shows the print progress dialog
@param parent - a DOM windows the dialog will be parented to (required)
@param printSettings - PrintSettings for page setup (required)
@param aObs - An observer to know if the contents of the Print Settings
object has changed while the dialog is being shown.
For example, some platforms may implement an "Apply" button (not required)
This service enables embedders to implement their own Print and Progress Dialogs.
Each platform has a "base" or "basckstop" implementation of the service. The
service is automatically registered at start up.
Historically, platform toolkits with native dialogs have implemented them in the GFX layer
Usually they were displayed when a new DeviceContextSpec specific to that platform
was created.
Windows: The GFX layer no longers supports default toolkit behavior for displaying the
native Print Dialog.
If an embedder implemented service returns any error code (other than NS_ERROR_ABORT)
printing will terminate.
Returning NS_OK assumes that the PrintSettings object was correctly filled in and
if it does not have valid fields for printer name, etc. it may also terminate.
Defaults for platform service:
showPrintDialog - displays a native dialog
showPageSetup - displays a XUL dialog
showProgress - displays a XUL dialog
showPrinterProperties - n/a
Summary for Windows Embedders:
Stated once again: There is no "fallback" native platform support in GFX for the
displaying of the native print dialog. The current default implementation for Windows
display a native print dialog but a XUL-based progress dialog.
If you wish to have a native progress dialog on Windows you will have to create and
register your own service.
Note: The Windows version Mozilla implements this service which is
automatically built and registered for you. You can use it as an example.
It is located at "mozilla/embedding/components/printingui/src/win". That service
is capable of displaying a native print dialog and a XUL progress dialog.
To fly your own dialog you may:
1) Implement this service to display at least the Print Dialog and a Print Progress Dialog
or you may implement just one of the dialogs and pass back NS_ERROR_NOT_IMPLEMENTED
for any of the others.
2) For the Print Dialog:
You may stub out this service by having all the methods return NS_ERROR_NOT_IMPLEMENTED.
You can then fly you own dialog and then properly fill in the PrintSettings object
before calling nsIWebBrowserPrint's Print method. If you stub out this service
you MUST set "printSilent" to true, if you do not, Printing will terminate and an
error dialog will be displayed.
Mac: The GFX layer still supports default toolkit behavior for displaying the Print Dialog.
If an embedder implemented service returns NS_ERROR_NOT_IMPLEMENTED for "showPrintDialog"
The toolkit will display the native print dialog.
Defaults for platform service:
Mac OS9: showPrintDialog - displays a native dialog
showPageSetup - displays a native dialog
showProgress - displays a XUL dialog
showPrinterProperties - n/a
Mac OSX: showPrintDialog - displays a native dialog
showPageSetup - displays a native dialog
showProgress - not implemented (provided by OS)
showPrinterProperties - n/a
GTK: There are no native dialog for GTK.
Defaults for platform service:
showPrintDialog - displays a XUL dialog
showPageSetup - displays a XUL dialog
showProgress - displays a XUL dialog
showPrinterProperties - displays a XUL dialog
OS2:
Defaults for platform service:
showPrintDialog - displays a XUL dialog
showPageSetup - displays a XUL dialog
showProgress - displays a XUL dialog
showPrinterProperties - displays a native dialog
Show the Print Dialog
@param parent - a DOM windows the dialog will be parented to (required)
@param webBrowserPrint - represents the document to be printed (required)
@param printSettings - PrintSettings for print "job" (required)
void
showPrintDialog(in nsIDOMWindow parent, in nsIWebBrowserPrint webBrowserPrint, in nsIPrintSettings printSettings)
Sometimes platforms need to bring up a special properties dialog for showing print specific properties. Although the PrintSettings has a place to set the printer name, here is is an argument to be clear as to what printer is being asked to have the properties set for it. The Printer name in the PS is ignored. @param parent - a DOM windows the dialog will be parented to (required) @param printerName - name of printer (required) @param printSettings - PrintSettings for page setup (required)
void
showPrinterProperties(in nsIDOMWindow parent, in wstring printerName, in nsIPrintSettings printSettings)
Shows the print progress dialog
@param parent - a DOM windows the dialog will be parented to
@param webBrowserPrint - represents the document to be printed
@param printSettings - PrintSettings for print "job"
@param openDialogObserver - an observer that will be notifed when the dialog is opened
@param isForPrinting - true - for printing, false for print preview
@param webProgressListener - additional listener can be registered for progress notifications
@param printProgressParams - parameter object for passing progress state
@param notifyOnOpen - this indicates that the observer will be notified when the progress
dialog has been opened. If false is returned it means the observer
(usually the caller) shouldn't wait
For Print Preview Progress there is intermediate progress
void
showProgress(in nsIDOMWindow parent, in nsIWebBrowserPrint webBrowserPrint, in nsIPrintSettings printSettings, in nsIObserver openDialogObserver, in boolean isForPrinting, out nsIWebProgressListener webProgressListener, out nsIPrintProgressParams printProgressParams, out boolean notifyOnOpen)
From nsIPromptFactory
Returns an object implementing the specified interface that creates prompts parented to aParent.
void
getPrompt(in nsIDOMWindow aParent, in nsIIDRef iid, [retval, iid_is(iid)] out nsQIResult result)
From nsIPromptService
Puts up an alert dialog with an OK button.
@param aParent
The parent window or null.
@param aDialogTitle
Text to appear in the title of the dialog.
@param aText
Text to appear in the body of the dialog.
Puts up an alert dialog with an OK button and a labeled checkbox.
@param aParent
The parent window or null.
@param aDialogTitle
Text to appear in the title of the dialog.
@param aText
Text to appear in the body of the dialog.
@param aCheckMsg
Text to appear with the checkbox.
@param aCheckState
Contains the initial checked state of the checkbox when this method
is called and the final checked state after this method returns.
void
alertCheck(in nsIDOMWindow aParent, in wstring aDialogTitle, in wstring aText, in wstring aCheckMsg, inout boolean aCheckState)
Puts up a dialog with OK and Cancel buttons.
@param aParent
The parent window or null.
@param aDialogTitle
Text to appear in the title of the dialog.
@param aText
Text to appear in the body of the dialog.
@return true for OK, false for Cancel
Puts up a dialog with OK and Cancel buttons and a labeled checkbox.
@param aParent
The parent window or null.
@param aDialogTitle
Text to appear in the title of the dialog.
@param aText
Text to appear in the body of the dialog.
@param aCheckMsg
Text to appear with the checkbox.
@param aCheckState
Contains the initial checked state of the checkbox when this method
is called and the final checked state after this method returns.
@return true for OK, false for Cancel
boolean
confirmCheck(in nsIDOMWindow aParent, in wstring aDialogTitle, in wstring aText, in wstring aCheckMsg, inout boolean aCheckState)
Puts up a dialog with up to 3 buttons and an optional, labeled checkbox.
@param aParent
The parent window or null.
@param aDialogTitle
Text to appear in the title of the dialog.
@param aText
Text to appear in the body of the dialog.
@param aButtonFlags
A combination of Button Flags.
@param aButton0Title
Used when button 0 uses TITLE_IS_STRING
@param aButton1Title
Used when button 1 uses TITLE_IS_STRING
@param aButton2Title
Used when button 2 uses TITLE_IS_STRING
@param aCheckMsg
Text to appear with the checkbox. Null if no checkbox.
@param aCheckState
Contains the initial checked state of the checkbox when this method
is called and the final checked state after this method returns.
@return 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.
PRInt32
confirmEx(in nsIDOMWindow aParent, in wstring aDialogTitle, in wstring aText, in unsigned long aButtonFlags, in wstring aButton0Title, in wstring aButton1Title, in wstring aButton2Title, in wstring aCheckMsg, inout boolean aCheckState)
Puts up a dialog with an edit field and an optional, labeled checkbox.
@param aParent
The parent window or null.
@param aDialogTitle
Text to appear in the title of the dialog.
@param aText
Text to appear in the body of the dialog.
@param aValue
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.
@param aCheckMsg
Text to appear with the checkbox. If null, check box will not be shown.
@param aCheckState
Contains the initial checked state of the checkbox when this method
is called and the final checked state after this method returns.
@return true for OK, false for Cancel.
boolean
prompt(in nsIDOMWindow aParent, in wstring aDialogTitle, in wstring aText, inout wstring aValue, in wstring aCheckMsg, inout boolean aCheckState)
Puts up a dialog with a password field and an optional, labeled checkbox.
@param aParent
The parent window or null.
@param aDialogTitle
Text to appear in the title of the dialog.
@param aText
Text to appear in the body of the dialog.
@param aPassword
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.
@param aCheckMsg
Text to appear with the checkbox. If null, check box will not be shown.
@param aCheckState
Contains the initial checked state of the checkbox when this method
is called and the final checked state after this method returns.
@return true for OK, false for Cancel.
boolean
promptPassword(in nsIDOMWindow aParent, in wstring aDialogTitle, in wstring aText, inout wstring aPassword, in wstring aCheckMsg, inout boolean aCheckState)
Puts up a dialog with an edit field, a password field, and an optional,
labeled checkbox.
@param aParent
The parent window or null.
@param aDialogTitle
Text to appear in the title of the dialog.
@param aText
Text to appear in the body of the dialog.
@param aUsername
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.
@param aPassword
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.
@param aCheckMsg
Text to appear with the checkbox. If null, check box will not be shown.
@param aCheckState
Contains the initial checked state of the checkbox when this method
is called and the final checked state after this method returns.
@return true for OK, false for Cancel.
boolean
promptUsernameAndPassword(in nsIDOMWindow aParent, in wstring aDialogTitle, in wstring aText, inout wstring aUsername, inout wstring aPassword, in wstring aCheckMsg, inout boolean aCheckState)
Puts up a dialog box which has a list box of strings from which the user
may make a single selection.
@param aParent
The parent window or null.
@param aDialogTitle
Text to appear in the title of the dialog.
@param aText
Text to appear in the body of the dialog.
@param aCount
The length of the aSelectList array parameter.
@param aSelectList
The list of strings to display.
@param aOutSelection
Contains the index of the selected item in the list when this
method returns true.
@return true for OK, false for Cancel.
boolean
select(in nsIDOMWindow aParent, in wstring aDialogTitle, in wstring aText, in PRUint32 aCount, [array, size_is(aCount)] in wstring aSelectList, out long aOutSelection)
From nsIPromptService2
nsICancelable
asyncPromptAuth(in nsIDOMWindow aParent, in nsIChannel aChannel, in nsIAuthPromptCallback aCallback, in nsISupports aContext, in PRUint32 level, in nsIAuthInformation authInfo, in wstring checkboxLabel, inout boolean checkValue)
boolean
promptAuth(in nsIDOMWindow aParent, in nsIChannel aChannel, in PRUint32 level, in nsIAuthInformation authInfo, in wstring checkboxLabel, inout boolean checkValue)
From nsISecureBrowserUI
From nsISessionStore
@param aWindow is the browser window to get the value for. @param aKey is the value's name.
Duplicates a given tab as thoroughly as possible. @param aWindow is the browser window into which the tab will be duplicated. @param aTab is the tabbrowser tab to duplicate (can be from a different window). @returns a reference to the newly created tab.
Get the number of restore-able tabs for a browser window
Get closed tab data @param aWindow is the browser window for which to get closed tab data @returns a JSON string representing the list of closed tabs.
@param aWindow is the browser window whose state is to be returned. @returns a JSON string representing a session state with only one window.
@param aWindow is the window to get the value for. @param aKey is the value's name. @returns A string value or an empty string if none is set.
Initialize the service
@param aWindow is the browser window whose state is to be set. @param aState is a JSON string representing a session state. @param aOverwrite boolean overwrite existing tabs
@param aWindow is the browser window to set the value for. @param aKey is the value's name. @param aStringValue is the value itself (use toSource/eval before setting JS objects).
@param aWindow is the browser window to reopen a closed tab in. @param aIndex is the index of the tab to be restored (FIFO ordered). @returns a reference to the reopened tab.
From nsIUpdatePrompt
Shows a list of all updates installed to date.
@param parent
A parent window to anchor this window to. Can be null.
From nsIWebBrowserPrint
Print Preview the specified DOM window
@param aThePrintSettings - Printer Settings for the print preview, if aThePrintSettings is null
then the global PS will be used.
@param aChildDOMWin - DOM Window of the child document to be PP (FrameSet frames)
@param aWPListener - is updated during the printpreview
@return void
void
printPreview(in nsIPrintSettings aThePrintSettings, in nsIDOMWindow aChildDOMWin, in nsIWebProgressListener aWPListener)
From nsIWebContentHandlerRegistrar
See documentation in nsIDOMClientInformation.idl The additional contentWindow param for both methods represents the dom content window from which the method has been called.
void
registerContentHandler(in DOMString mimeType, in DOMString uri, in DOMString title, in nsIDOMWindow contentWindow)
void
registerProtocolHandler(in DOMString protocol, in DOMString uri, in DOMString title, in nsIDOMWindow contentWindow)
From nsIWindowProvider
A method to request that this provider provide a window. The window
returned need not to have the right name or parent set on it; setting
those is the caller's responsibility. The provider can always return null
to have the caller create a brand-new window.
@param aParent Must not be null. This is the window that the caller wants
to use as the parent for the new window. Generally,
nsIWindowProvider implementors can expect to be somehow
related to aParent; the relationship may depend on the
nsIWindowProvider implementation.
@param aChromeFlags The chrome flags the caller will use to create a new
window if this provider returns null. See
nsIWebBrowserChrome for the possible values of this
field.
@param aPositionSpecified Whether the attempt to create a window is trying
to specify a position for the new window.
@param aSizeSpecified Whether the attempt to create a window is trying to
specify a size for the new window.
@param aURI The URI to be loaded in the new window. The nsIWindowProvider
implementation MUST NOT load this URI in the window it
returns. This URI is provided solely to help the
nsIWindowProvider implenentation make decisions; the caller
will handle loading the URI in the window returned if
provideWindow returns a window. Note that the URI may be null
if the load cannot be represented by a single URI (e.g. if
the load has extra load flags, POST data, etc).
@param aName The name of the window being opened. Setting the name on the
return value of provideWindow will be handled by the caller;
aName is provided solely to help the nsIWindowProvider
implementation make decisions.
@param aFeatures The feature string for the window being opened. This may
be empty. The nsIWindowProvider implementation is
allowed to apply the feature string to the window it
returns in any way it sees fit. See the nsIWindowWatcher
interface for details on feature strings.
@param aWindowIsNew [out] Whether the window being returned was just
created by the window provider implementation.
This can be used by callers to keep track of which
windows were opened by the user as opposed to
being opened programmatically. This should be set
to false if the window being returned existed
before the provideWindow() call. The value of this
out parameter is meaningless if provideWindow()
returns null.
@return A window the caller should use or null if the caller should just
create a new window. The returned window may be newly opened by
the nsIWindowProvider implementation or may be a window that
already existed.
@see nsIWindowWatcher for more information on aFeatures.
@see nsIWebBrowserChrome for more information on aChromeFlags.
nsIDOMWindow
provideWindow(in nsIDOMWindow aParent, in unsigned long aChromeFlags, in boolean aPositionSpecified, in boolean aSizeSpecified, in nsIURI aURI, in AString aName, in AUTF8String aFeatures, out boolean aWindowIsNew)
From nsIWindowWatcher
Retrieve an existing window (or frame).
@param aTargetName the window name
@param aCurrentWindow a starting point in the window hierarchy to
begin the search. If null, each toplevel window
will be searched.
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!
Return a newly created nsIAuthPrompt implementation.
@param aParent the parent window used for posing alerts. can be null.
@return a new nsIAuthPrompt object
Return a newly created nsIPrompt implementation.
@param aParent the parent window used for posing alerts. can be null.
@return a new nsIPrompt object
Create a new window. It will automatically be added to our list
(via addWindow()).
@param aParent 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.
@param aURL url to which to open the new window. Must already be
escaped, if applicable. can be null.
@param aName 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.
@param aFeatures window features from JS window.open. can be null.
@param aArguments extra argument(s) to the new window, to be attached
as the |arguments| property. An nsISupportsArray will be
unwound into multiple arguments (but not recursively!).
can be null.
@return the new window
@note 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.
@note This method should try to set the default charset for the new
window to the default charset of aParent. This is not guaranteed,
however.
@note This method may dispatch a "toplevel-window-ready" notification
via nsIObserverService if the window did not already exist.
nsIDOMWindow
openWindow(in nsIDOMWindow aParent, in string aUrl, in string aName, in string aFeatures, in nsISupports aArguments)
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.
@param aWindow the DOM window whose chrome window the caller needs
@return the corresponding chrome window
From nsIXPIDialogService
@brief Ask the user if it's OK to install
When called the XPIDialogService implementation should pose an
install confirmation dialog and return the user's response
@param parent a window that can be used to parent the modal dialog
@param packageList For each install package there will be three strings,
a display name, a source URL, and a the name of the
organization that signed this install. Note that the
name of the signer is not verified. Verification
happens when the the install has completely downloaded.
Your user interface should only suggest that the
install may be signed by this organization name.
Note that an unsigned archive is indicated by an
empty string.
@param count The number of strings in the packageList. This
will always be three times the number of
packages.
@return true to install, false to cancel
boolean
confirmInstall(in nsIDOMWindow parent, [array, size_is(count)] in wstring packageList, in unsigned long count)
From nsPICommandUpdater
From nsPIPromptService
From nsPIWindowWatcher
Like the public interface's open(), but can deal with openDialog
style arguments.
@param aParent 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.
@param aURL url to which to open the new window. Must already be
escaped, if applicable. can be null.
@param aName 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.
@param aFeatures window features from JS window.open. can be null.
@param aDialog use dialog defaults (see nsIDOMWindowInternal::openDialog)
@param aArgs Window argument
@return the new window
@note 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.
@note This method should try to set the default charset for the new
window to the default charset of the document in the calling window
(which is determined based on the JS stack and the value of
aParent). This is not guaranteed, however.
nsIDOMWindow
openWindowJS(in nsIDOMWindow aParent, in string aUrl, in string aName, in string aFeatures, in boolean aDialog, in nsIArray aArgs)
A window has been created. Add it to our list.
@param aWindow the window to add
@param aChrome the corresponding chrome window. The DOM window
and chrome will be mapped together, and the corresponding
chrome can be retrieved using the (not private)
method getChromeForWindow. If null, any extant mapping
will be cleared.
A window has been closed. Remove it from our list.
@param aWindow the window to remove