This interface is used to implement the user interface for the Download Manager. If you wish to replace the default Download Manager user interface, implement this interface.
1.0
28
Introduced
Gecko 1.9
Inherits from:
nsISupports
Last changed in Gecko 1.9 (Firefox 3)Method overview
void getAttention(); |
void show([optional] in nsIInterfaceRequestor aWindowContext, [optional] in unsigned long aID, [optional] in short aReason); |
Attributes
| Attribute | Type | Description |
visible | boolean | true if the Download Manager UI is visible; otherwise false. Read only. |
Constants
| Constant | Value | Description |
REASON_USER_INTERACTED | 0 | When opening the Download Manager user interface, this value indicates that it's being done at the user's request. |
REASON_NEW_DOWNLOAD | 1 | When opening the Download Manager user interface, this value indicates that the user interface is being displayed because a new download is being started. |
Methods
getAttention()
Calls attention to the Download Manager's user interface if it's already open. The UI need not be visible to call this function, nor will the UI be made visible.
void getAttention();
Parameters
None.
Exceptions thrown
NS_ERROR_UNEXPECTED- The user interface isn't currently open.
show()
Shows the Download Manager's user interface to the user.
void show( in nsIInterfaceRequestor aWindowContext, Optional in unsigned long aID, Optional in short aReason Optional );
Parameters
aWindowContextOptional- The parent window context to show the user interface. With this information, it's possible to put the Download Manager in a tab in the same window as the parent.
aIDOptional- The ID of the download to be preselected upon opening the Download Manager UI.
aReasonOptional- One of the reason constants indicating why the user interface should be displayed.