Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIHelperAppLauncher Interface Reference

A helper app launcher is a small object created to handle the launching of an external application. More...

import "nsIExternalHelperAppService.idl";

Inheritance diagram for nsIHelperAppLauncher:
Inheritance graph
[legend]
Collaboration diagram for nsIHelperAppLauncher:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void saveToDisk (in nsIFile aNewFileLocation, in boolean aRememberThisPreference)
 Called when we want to just save the content to a particular file.
void launchWithApplication (in nsIFile aApplication, in boolean aRememberThisPreference)
 Use aApplication to launch with this content.
void setWebProgressListener (in nsIWebProgressListener2 aWebProgressListener)
 The following methods are used by the progress dialog to get or set information on the current helper app launcher download.
void closeProgressWindow ()
 when the stand alone progress window actually closes, it calls this method so we can release any local state...
void cancel (in nsresult aReason)
 Call this method to request that this object abort whatever operation it may be performing.

Public Attributes

readonly attribute nsIMIMEInfo MIMEInfo
 The mime info object associated with the content type this helper app launcher is currently attempting to load.
readonly attribute nsIURI source
 The source uri.
readonly attribute AString suggestedFileName
 The suggested name for this file.
readonly attribute nsIFile targetFile
 The file we are saving to.
readonly attribute PRTime timeDownloadStarted
 Time when the download started.

Detailed Description

A helper app launcher is a small object created to handle the launching of an external application.

Note that cancelling the load via the nsICancelable interface will release the reference to the launcher dialog.

Definition at line 105 of file nsIExternalHelperAppService.idl.


Member Function Documentation

void nsICancelable::cancel ( in nsresult  aReason) [inherited]

Call this method to request that this object abort whatever operation it may be performing.

Parameters:
aReasonPass a failure code to indicate the reason why this operation is being canceled. It is an error to pass a success code.

when the stand alone progress window actually closes, it calls this method so we can release any local state...

void nsIHelperAppLauncher::launchWithApplication ( in nsIFile  aApplication,
in boolean  aRememberThisPreference 
)

Use aApplication to launch with this content.

NOTE: This will release the reference to the nsIHelperAppLauncherDialog.

Parameters:
aApplicationnsIFile corresponding to the location of the application to use.
aRememberThisPreferenceTRUE if we should remember this choice.
void nsIHelperAppLauncher::saveToDisk ( in nsIFile  aNewFileLocation,
in boolean  aRememberThisPreference 
)

Called when we want to just save the content to a particular file.

NOTE: This will release the reference to the nsIHelperAppLauncherDialog.

Parameters:
aNewFileLocationLocation where the content should be saved

Here is the caller graph for this function:

The following methods are used by the progress dialog to get or set information on the current helper app launcher download.

This reference will be released when the download is finished (after the listener receives the STATE_STOP notification).


Member Data Documentation

The mime info object associated with the content type this helper app launcher is currently attempting to load.

Definition at line 111 of file nsIExternalHelperAppService.idl.

The source uri.

Definition at line 116 of file nsIExternalHelperAppService.idl.

The suggested name for this file.

Definition at line 121 of file nsIExternalHelperAppService.idl.

The file we are saving to.

Definition at line 155 of file nsIExternalHelperAppService.idl.

Time when the download started.

Definition at line 159 of file nsIExternalHelperAppService.idl.


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