Public Member Functions | Public Attributes

nsIHelperAppLauncherDialog Interface Reference

This interface is used to display a confirmation dialog before launching a "helper app" to handle content not handled by Mozilla. More...

import "nsIHelperAppLauncherDialog.idl";

List of all members.

Public Member Functions

void show (in nsIHelperAppLauncher aLauncher, in nsISupports aWindowContext, in unsigned long aReason)
 Show confirmation dialog for launching application (or "save to disk") for content specified by aLauncher.
nsILocalFile promptForSaveToFile (in nsIHelperAppLauncher aLauncher, in nsISupports aWindowContext, in wstring aDefaultFileName, in wstring aSuggestedFileExtension, in boolean aForcePrompt)
 Invoke a save-to-file dialog instead of the full fledged helper app dialog.

Public Attributes

const unsigned long REASON_CANTHANDLE = 0
 This request is passed to the helper app dialog because Gecko can not handle content of this type.
const unsigned long REASON_SERVERREQUEST = 1
 The server requested external handling.
const unsigned long REASON_TYPESNIFFED = 2
 Gecko detected that the type sent by the server (e.g.

Detailed Description

This interface is used to display a confirmation dialog before launching a "helper app" to handle content not handled by Mozilla.

Usage: Clients (of which there is one: the nsIExternalHelperAppService implementation in mozilla/uriloader/exthandler) create an instance of this interface (using the contract ID) and then call the show() method.

The dialog is shown non-modally. The implementation of the dialog will access methods of the nsIHelperAppLauncher passed in to show() in order to cause a "save to disk" or "open using" action.


Member Function Documentation

nsILocalFile nsIHelperAppLauncherDialog::promptForSaveToFile ( in nsIHelperAppLauncher  aLauncher,
in nsISupports  aWindowContext,
in wstring  aDefaultFileName,
in wstring  aSuggestedFileExtension,
in boolean  aForcePrompt 
)

Invoke a save-to-file dialog instead of the full fledged helper app dialog.

Returns the a nsILocalFile for the file name/location selected.

Parameters:
aLauncher A nsIHelperAppLauncher to be invoked when a file is selected.
aWindowContext Window associated with action.
aDefaultFileName Default file name to provide (can be null)
aSuggestedFileExtension Sugested file extension
aForcePrompt Set to true to force prompting the user for thet file name/location, otherwise perferences may control if the user is prompted.
void nsIHelperAppLauncherDialog::show ( in nsIHelperAppLauncher  aLauncher,
in nsISupports  aWindowContext,
in unsigned long  aReason 
)

Show confirmation dialog for launching application (or "save to disk") for content specified by aLauncher.

Parameters:
aLauncher A nsIHelperAppLauncher to be invoked when a file is selected.
aWindowContext Window associated with action.
aReason One of the constants from above. It indicates why the dialog is shown. Implementors should treat unknown reasons like REASON_CANTHANDLE.

Member Data Documentation

This request is passed to the helper app dialog because Gecko can not handle content of this type.

The server requested external handling.

Gecko detected that the type sent by the server (e.g.

text/plain) does not match the actual type.


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