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:
Collaboration diagram for nsIHelperAppLauncher:

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...

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 boolean targetFileIsExecutable
 The executable-ness of the target file.
readonly attribute PRTime timeDownloadStarted
 Time when the download started.
readonly attribute PRInt64 contentLength
 The download content length, or -1 if the length is not available.

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.


Member Function Documentation

void nsIHelperAppLauncher::closeProgressWindow (  ) 

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:
aApplication nsIFile corresponding to the location of the application to use.
aRememberThisPreference TRUE 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:
aNewFileLocation Location where the content should be saved
void nsIHelperAppLauncher::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.

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


Member Data Documentation

The download content length, or -1 if the length is not available.

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

The source uri.

readonly attribute AString nsIHelperAppLauncher::suggestedFileName

The suggested name for this file.

The file we are saving to.

The executable-ness of the target file.

Time when the download started.


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