mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-14 15:37:55 +00:00
121 lines
4.7 KiB
Plaintext
121 lines
4.7 KiB
Plaintext
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* 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 mozilla.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
interface nsIHelperAppLauncher;
|
|
interface nsILocalFile;
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
[scriptable, uuid(f3704fdc-8ae6-4eba-a3c3-f02958ac0649)]
|
|
interface nsIHelperAppLauncherDialog : nsISupports {
|
|
/**
|
|
* This request is passed to the helper app dialog because Gecko can not
|
|
* handle content of this type.
|
|
*/
|
|
const unsigned long REASON_CANTHANDLE = 0;
|
|
|
|
/**
|
|
* The server requested external handling.
|
|
*/
|
|
const unsigned long REASON_SERVERREQUEST = 1;
|
|
|
|
/**
|
|
* Gecko detected that the type sent by the server (e.g. text/plain) does
|
|
* not match the actual type.
|
|
*/
|
|
const unsigned long REASON_TYPESNIFFED = 2;
|
|
|
|
/**
|
|
* Show confirmation dialog for launching application (or "save to
|
|
* disk") for content specified by aLauncher.
|
|
*
|
|
* @param aLauncher
|
|
* A nsIHelperAppLauncher to be invoked when a file is selected.
|
|
* @param aWindowContext
|
|
* Window associated with action.
|
|
* @param aReason
|
|
* One of the constants from above. It indicates why the dialog is
|
|
* shown. Implementors should treat unknown reasons like
|
|
* REASON_CANTHANDLE.
|
|
*/
|
|
void show(in nsIHelperAppLauncher aLauncher,
|
|
in nsISupports aWindowContext,
|
|
in unsigned long aReason);
|
|
|
|
/**
|
|
* Invoke a save-to-file dialog instead of the full fledged helper app dialog.
|
|
* Returns the a nsILocalFile for the file name/location selected.
|
|
*
|
|
* @param aLauncher
|
|
* A nsIHelperAppLauncher to be invoked when a file is selected.
|
|
* @param aWindowContext
|
|
* Window associated with action.
|
|
* @param aDefaultFileName
|
|
* Default file name to provide (can be null)
|
|
* @param aSuggestedFileExtension
|
|
* Sugested file extension
|
|
* @param aForcePrompt
|
|
* Set to true to force prompting the user for thet file
|
|
* name/location, otherwise perferences may control if the user is
|
|
* prompted.
|
|
*/
|
|
nsILocalFile promptForSaveToFile(in nsIHelperAppLauncher aLauncher,
|
|
in nsISupports aWindowContext,
|
|
in wstring aDefaultFileName,
|
|
in wstring aSuggestedFileExtension,
|
|
in boolean aForcePrompt);
|
|
};
|
|
|
|
|
|
%{C++
|
|
#define NS_HELPERAPPLAUNCHERDLG_CONTRACTID "@mozilla.org/helperapplauncherdialog;1"
|
|
#define NS_IHELPERAPPLAUNCHERDLG_CLASSNAME "Mozilla Helper App Launcher Confirmation Dialog"
|
|
%}
|