mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-02 15:15:23 +00:00
915b893dac
this is mostly converting //-style comments to /**-style ones and using @param r=bzbarsky sr=darin
150 lines
5.0 KiB
Plaintext
150 lines
5.0 KiB
Plaintext
/* -*- Mode: C++; tab-width: 3; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public
|
|
* License Version 1.1 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS
|
|
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
|
* implied. See the License for the specific language governing
|
|
* rights and limitations under the License.
|
|
*
|
|
* The Original Code is the Mozilla browser.
|
|
*
|
|
* The Initial Developer of the Original Code is Netscape
|
|
* Communications, Inc. Portions created by Netscape are
|
|
* Copyright (C) 1999, Mozilla. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
* Scott MacGregor <mscott@netscape.com>
|
|
*/
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
interface nsIURI;
|
|
interface nsIRequest;
|
|
interface nsIStreamListener;
|
|
interface nsIFile;
|
|
interface nsIMIMEInfo;
|
|
interface nsIWebProgressListener;
|
|
|
|
/**
|
|
* The external helper app service is used for finding and launching
|
|
* platform specific external applications for a given mime content type.
|
|
*/
|
|
[scriptable, uuid(663CC0AA-42EA-11d4-98D0-001083010E9B)]
|
|
interface nsIExternalHelperAppService : nsISupports
|
|
{
|
|
/**
|
|
* Binds an external helper application to a stream listener. The caller
|
|
* should pump data into the returned stream listener. When the OnStopRequest
|
|
* is issued, the stream listener implementation will launch the helper app
|
|
* with this data.
|
|
* @param aMimeContentType The content type of the incoming data
|
|
* @param aRequest The request corresponding to the incoming data
|
|
* @param aWindowContext Use GetInterface to retrieve properties like the
|
|
* dom window or parent window...
|
|
* The service might need this in order to bring up dialogs.
|
|
* @return A nsIStreamListener which the caller should pump the data into.
|
|
*/
|
|
nsIStreamListener doContent (in string aMimeContentType, in nsIRequest aRequest,
|
|
in nsISupports aWindowContext);
|
|
|
|
/**
|
|
* Returns true if this type is to be decoded prior to saving or passing
|
|
* off to helper apps, false otherwise
|
|
*/
|
|
boolean applyDecodingForType (in string aMimeContentType);
|
|
|
|
/**
|
|
* Returns false if files with this extension are not to be decoded prior
|
|
* to saving or passing off to helper apps, false otherwise
|
|
*/
|
|
boolean applyDecodingForExtension(in string aExtension);
|
|
};
|
|
|
|
/**
|
|
* This is a private interface shared between external app handlers and the platform specific
|
|
* external helper app service
|
|
*/
|
|
[scriptable, uuid(491D04D5-449C-11d4-98D0-001083010E9B)]
|
|
interface nsPIExternalAppLauncher : nsISupports
|
|
{
|
|
/**
|
|
* Used by the handler to actually launch the helper application.
|
|
* @param aTempFile The file which contains the data we want the helper app
|
|
* to use when it is launched
|
|
*/
|
|
void launchAppWithTempFile(in nsIMIMEInfo aMIMEInfo, in nsIFile aTempFile);
|
|
|
|
/**
|
|
* mscott --> eventually I should move this into a new service so other
|
|
* consumers can add temporary files they want deleted on exit.
|
|
* @param aTemporaryFile A temporary file we should delete on exit.
|
|
*/
|
|
void deleteTemporaryFileOnExit(in nsIFile aTemporaryFile);
|
|
};
|
|
|
|
/**
|
|
* A helper app launcher is a small object created to handle the launching
|
|
* of an external application.
|
|
*/
|
|
[scriptable, uuid(9503D0FE-4C9D-11d4-98D0-001083010E9B)]
|
|
interface nsIHelperAppLauncher : nsISupports
|
|
{
|
|
/**
|
|
* The mime info object associated with the content type this helper app
|
|
* launcher is currently attempting to load
|
|
*/
|
|
readonly attribute nsIMIMEInfo MIMEInfo;
|
|
|
|
/**
|
|
* The source uri
|
|
*/
|
|
readonly attribute nsIURI source;
|
|
|
|
/**
|
|
* The suggested name for this file
|
|
*/
|
|
readonly attribute wstring suggestedFileName;
|
|
|
|
/**
|
|
* Called when we want to just save the content to a particular file
|
|
* @param aNewFileLocation Location where the content should be saved
|
|
*/
|
|
void saveToDisk(in nsIFile aNewFileLocation, in boolean aRememberThisPreference);
|
|
|
|
/**
|
|
* Use aApplication to launch with this content.
|
|
* @param aApplication nsIFile corresponding to the location of the application to use.
|
|
* @param aRememberThisPreference TRUE if we should remember this choice.
|
|
*/
|
|
void launchWithApplication(in nsIFile aApplication, in boolean aRememberThisPreference);
|
|
|
|
/**
|
|
* Called if the user decides to cancel the handling of this content type
|
|
*/
|
|
void Cancel();
|
|
|
|
/**
|
|
* the following methods are used by the progress dialog to get or set
|
|
* information on the current helper app launcher download.
|
|
*/
|
|
void setWebProgressListener(in nsIWebProgressListener aWebProgressListener);
|
|
/**
|
|
* when the stand alone progress window actually closes, it calls this method
|
|
* so we can release any local state...
|
|
*/
|
|
void closeProgressWindow();
|
|
|
|
/**
|
|
* The file we are saving to
|
|
*/
|
|
readonly attribute nsIFile targetFile;
|
|
/**
|
|
* Time when the download started
|
|
*/
|
|
readonly attribute PRTime timeDownloadStarted;
|
|
};
|