Public Member Functions | Public Attributes

nsIDownloadManagerUI Interface Reference

import "nsIDownloadManagerUI.idl";

Inheritance diagram for nsIDownloadManagerUI:

List of all members.

Public Member Functions

void show ([optional] in nsIInterfaceRequestor aWindowContext,[optional] in unsigned long aID,[optional] in short aReason)
 Shows the Download Manager's UI to the user.
void getAttention ()
 Brings attention to the UI if it is already visible.

Public Attributes

const short REASON_USER_INTERACTED = 0
 The reason that should be passed when the user requests to show the download manager's UI.
const short REASON_NEW_DOWNLOAD = 1
 The reason that should be passed to the show method when we are displaying the UI because a new download is being added to it.
readonly attribute boolean visible
 Indicates if the UI is visible or not.

Member Function Documentation

void nsIDownloadManagerUI::getAttention (  ) 

Brings attention to the UI if it is already visible.

Exceptions:
NS_ERROR_UNEXPECTED if the UI is not visible.
void nsIDownloadManagerUI::show ( [optional] in nsIInterfaceRequestor  aWindowContext,
[optional] in unsigned long  aID,
[optional] in short  aReason 
)

Shows the Download Manager's UI to the user.

Parameters:
[optional] aWindowContext The parent window context to show the UI.
[optional] aID The id of the download to be preselected upon opening.
[optional] aReason The reason to show the download manager's UI. This defaults to REASON_USER_INTERACTED, and should be one of the previously listed constants.

Member Data Documentation

The reason that should be passed to the show method when we are displaying the UI because a new download is being added to it.

The reason that should be passed when the user requests to show the download manager's UI.

Indicates if the UI is visible or not.


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