← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/embedding/components/ui/helperAppDlg/nsIHelperAppLauncherDialog.idl

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/embedding/components/ui/helperAppDlg/nsIHelperAppLauncherDialog.idl
 
1
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
 
2
/* ***** BEGIN LICENSE BLOCK *****
 
3
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 
4
 *
 
5
 * The contents of this file are subject to the Netscape Public License
 
6
 * Version 1.1 (the "License"); you may not use this file except in
 
7
 * compliance with the License. You may obtain a copy of the License at
 
8
 * http://www.mozilla.org/NPL/
 
9
 *
 
10
 * Software distributed under the License is distributed on an "AS IS" basis,
 
11
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 
12
 * for the specific language governing rights and limitations under the
 
13
 * License.
 
14
 *
 
15
 * The Original Code is mozilla.org code.
 
16
 *
 
17
 * The Initial Developer of the Original Code is 
 
18
 * Netscape Communications Corporation.
 
19
 * Portions created by the Initial Developer are Copyright (C) 1998
 
20
 * the Initial Developer. All Rights Reserved.
 
21
 *
 
22
 * Contributor(s):
 
23
 *
 
24
 *
 
25
 * Alternatively, the contents of this file may be used under the terms of
 
26
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 
27
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 
28
 * in which case the provisions of the GPL or the LGPL are applicable instead
 
29
 * of those above. If you wish to allow use of your version of this file only
 
30
 * under the terms of either the GPL or the LGPL, and not to allow others to
 
31
 * use your version of this file under the terms of the NPL, indicate your
 
32
 * decision by deleting the provisions above and replace them with the notice
 
33
 * and other provisions required by the GPL or the LGPL. If you do not delete
 
34
 * the provisions above, a recipient may use your version of this file under
 
35
 * the terms of any one of the NPL, the GPL or the LGPL.
 
36
 *
 
37
 * ***** END LICENSE BLOCK ***** */
 
38
 
 
39
#include "nsISupports.idl"
 
40
#include "domstubs.idl"
 
41
 
 
42
interface nsIHelperAppLauncher;
 
43
interface nsILocalFile;
 
44
 
 
45
/**
 
46
 * nsIHelperAppLauncherDialog
 
47
 * ==========================
 
48
 * This interface is used to display a confirmatino dialog before
 
49
 * launching a "helper app" to handle content not handled by
 
50
 * Mozilla.
 
51
 *
 
52
 * Usage:  Clients (of which there is one: the nsIExternalHelperAppService
 
53
 * implementation in mozilla/uriloader/exthandler) create an instance of
 
54
 * this interface (using the contract ID) and then call the show() method.
 
55
 *
 
56
 * The dialog is shown non-modally.  The implementation of the dialog
 
57
 * will access methods of the nsIHelperAppLauncher passed in to show()
 
58
 * in order to cause a "save to disk" or "open using" action.
 
59
 *
 
60
 * Note: The promptForSaveToFile method is
 
61
 *       obsolescent.  Caller(s) will be converted to use specific
 
62
 *       file-picker and progress-dialog interfaces.
 
63
 */
 
64
 
 
65
[scriptable, uuid(d7ebddf0-4c84-11d4-807a-00600811a9c3)]
 
66
interface nsIHelperAppLauncherDialog : nsISupports {
 
67
  // Show confirmation dialog for launching application (or "save to
 
68
  // disk") for content specified by aLauncher.
 
69
  // aForced is used to indicate whether this dialog was shown even though
 
70
  // the content could have been handled by mozilla; this is used if
 
71
  // an HTTP Server sends Content-Disposition: attachment
 
72
  void show(in nsIHelperAppLauncher aLauncher,
 
73
            in nsISupports aContext,
 
74
            in boolean aForced);
 
75
        
 
76
        // invoke a save to file dialog instead of the full fledged helper app dialog.
 
77
        // aDefaultFileName --> default file name to provide (can be null)
 
78
        // aSuggestedFileExtension --> sugested file extension
 
79
        // aFileLocation --> return value for the file location
 
80
  nsILocalFile promptForSaveToFile(in nsIHelperAppLauncher aLauncher, 
 
81
                                   in nsISupports aWindowContext, 
 
82
                                   in wstring aDefaultFile, 
 
83
                                   in wstring aSuggestedFileExtension);
 
84
};
 
85
 
 
86
 
 
87
%{C++
 
88
#define NS_IHELPERAPPLAUNCHERDLG_CONTRACTID    "@mozilla.org/helperapplauncherdialog;1"
 
89
#define NS_IHELPERAPPLAUNCHERDLG_CLASSNAME "Mozilla Helper App Launcher Confirmation Dialog"
 
90
%}