/embedding/components/windowwatcher/public/nsIPromptService2.idl

 1/* ***** BEGIN LICENSE BLOCK *****
 2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 3 *
 4 * The contents of this file are subject to the Mozilla Public License Version
 5 * 1.1 (the "License"); you may not use this file except in compliance with
 6 * the License. You may obtain a copy of the License at
 7 * http://www.mozilla.org/MPL/
 8 *
 9 * Software distributed under the License is distributed on an "AS IS" basis,
10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11 * for the specific language governing rights and limitations under the
12 * License.
13 *
14 * The Original Code is mozilla.org embedding code.
15 *
16 * The Initial Developer of the Original Code is
17 * Google Inc.
18 * Portions created by the Initial Developer are Copyright (C) 2006
19 * the Initial Developer. All Rights Reserved.
20 *
21 * Contributor(s):
22 *  Christian Biesinger <cbiesinger@web.de> (Original Author)
23 *
24 * Alternatively, the contents of this file may be used under the terms of
25 * either the GNU General Public License Version 2 or later (the "GPL"), or
26 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 * in which case the provisions of the GPL or the LGPL are applicable instead
28 * of those above. If you wish to allow use of your version of this file only
29 * under the terms of either the GPL or the LGPL, and not to allow others to
30 * use your version of this file under the terms of the MPL, indicate your
31 * decision by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL or the LGPL. If you do not delete
33 * the provisions above, a recipient may use your version of this file under
34 * the terms of any one of the MPL, the GPL or the LGPL.
35 *
36 * ***** END LICENSE BLOCK ***** */
37
38#include "nsIPromptService.idl"
39
40interface nsIAuthInformation;
41interface nsIAuthPromptCallback;
42interface nsICancelable;
43interface nsIChannel;
44interface nsIDOMWindow;
45
46/**
47 * This is an improved version of nsIPromptService that is less prescriptive
48 * about the resulting user interface.
49 *
50 * @status INCOMPLETE do not freeze before fixing bug 228207
51 */
52[scriptable, uuid(cf86d196-dbee-4482-9dfa-3477aa128319)]
53interface nsIPromptService2 : nsIPromptService {
54  // NOTE: These functions differ from their nsIAuthPrompt counterparts by
55  // having additional checkbox parameters
56  // checkValue can be null meaning to show no checkbox
57  // checkboxLabel is a wstring so that it can be null from both JS and C++ in
58  // a convenient way
59  //
60  // See nsIAuthPrompt2 for documentation on the semantics of the other
61  // parameters.
62  boolean promptAuth(in nsIDOMWindow aParent,
63                     in nsIChannel aChannel,
64                     in PRUint32 level,
65                     in nsIAuthInformation authInfo,
66                     in wstring checkboxLabel,
67                     inout boolean checkValue);
68
69  nsICancelable asyncPromptAuth(in nsIDOMWindow aParent,
70                                in nsIChannel aChannel,
71                                in nsIAuthPromptCallback aCallback,
72                                in nsISupports aContext,
73                                in PRUint32 level,
74                                in nsIAuthInformation authInfo,
75                                in wstring checkboxLabel,
76                                inout boolean checkValue);
77};
78