Back to index

lightning-sunbird  0.9+nobinonly
nsICookiePromptService.idl
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is cookie manager code.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Michiel van Leeuwen (mvl@exedo.nl).
00018  * Portions created by the Initial Developer are Copyright (C) 2003
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *
00023  * Alternatively, the contents of this file may be used under the terms of
00024  * either the GNU General Public License Version 2 or later (the "GPL"), or
00025  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00026  * in which case the provisions of the GPL or the LGPL are applicable instead
00027  * of those above. If you wish to allow use of your version of this file only
00028  * under the terms of either the GPL or the LGPL, and not to allow others to
00029  * use your version of this file under the terms of the MPL, indicate your
00030  * decision by deleting the provisions above and replace them with the notice
00031  * and other provisions required by the GPL or the LGPL. If you do not delete
00032  * the provisions above, a recipient may use your version of this file under
00033  * the terms of any one of the MPL, the GPL or the LGPL.
00034  *
00035  * ***** END LICENSE BLOCK ***** */
00036 
00037 #include "nsISupports.idl"
00038 
00043 interface nsIDOMWindow;
00044 interface nsICookie;
00045 
00046 [scriptable, uuid(72f8bb14-2810-4f38-8d0d-290c5401f54e)]
00047 interface nsICookiePromptService : nsISupports
00048 {
00049   const PRUint32 DENY_COOKIE = 0;
00050   const PRUint32 ACCEPT_COOKIE = 1;
00051   const PRUint32 ACCEPT_SESSION_COOKIE = 2;
00052 
00053   /* Open a dialog that asks for permission to accept a cookie
00054    * 
00055    * @param parent
00056    * @param cookie
00057    * @param hostname          the host that wants to set the cookie, 
00058    *                           not the domain: part of the cookie
00059    * @param cookiesFromHost   the number of cookies there are already for this host
00060    * @param changingCookie    are we changing this cookie?
00061    * @param rememberDecision  should we set the matching permission for this host?
00062    * @returns                 0 == deny cookie
00063    *                          1 == accept cookie
00064    *                          2 == accept cookie for current session
00065    */
00066 
00067   long cookieDialog(in nsIDOMWindow parent,
00068                     in nsICookie cookie,
00069                     in ACString hostname,
00070                     in long cookiesFromHost,
00071                     in boolean changingCookie,
00072                     out boolean rememberDecision);
00073 };
00074 
00075 %{C++
00076 #define NS_COOKIEPROMPTSERVICE_CONTRACTID "@mozilla.org/embedcomp/cookieprompt-service;1"
00077 %}