RetroZilla/netwerk/base/public/nsPIProtocolProxyService.idl
2015-10-20 23:03:22 -04:00

69 lines
3.0 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* vim:set ts=4 sw=4 sts=4 et: */
/* ***** 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):
* Darin Fisher <darin@meer.net>
*
* 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 "nsIProtocolProxyService.idl"
/**
* THIS IS A PRIVATE INTERFACE
*
* It exists purely as a hack to support the configureFromPAC method used by
* the preference panels in the various apps. Those apps need to be taught to
* just use the preferences API to "reload" the PAC file. Then, at that point,
* we can eliminate this interface completely.
*/
[scriptable, uuid(d2c7b3eb-7778-468b-ae9b-c106c2afb5d1)]
interface nsPIProtocolProxyService : nsIProtocolProxyService
{
/**
* This method may be called to re-configure proxy settings given a URI
* to a new proxy auto config file. This method may return before the
* configuration actually takes affect (i.e., the URI may be loaded
* asynchronously).
*
* WARNING: This method is considered harmful since it may cause the PAC
* preferences to be out of sync with the state of the Protocol Proxy
* Service. This method is going to be eliminated in the near future.
*
* @param aURI
* The location of the PAC file to load. If this value is empty,
* then the PAC configuration will be removed.
*/
void configureFromPAC(in AUTF8String aURI);
};