gecko/intl/chardet/public/nsICharsetResolver.idl

85 lines
3.7 KiB
Plaintext

/* -*- Mode: IDL; 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 the Character Set Resolver interface
*
* The Initial Developer of the Original Code is
* Netscape Communications Corp.
* Portions created by the Initial Developer are Copyright (C) 2003
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Alec Flett <alecf@flett.org>
*
* 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 nsIWebNavigation;
interface nsIChannel;
[scriptable, uuid(d143a084-b626-4614-845f-41f3ca43a674)]
interface nsICharsetResolver : nsISupports
{
/**
* Called to resolve the charset that should be used for parsing the
* document being loaded from aChannel.
*
* If the charset cannot be resolved, but the implementation of
* nsICharsetResolver wants to be notified of the final resolved charset
* when one is available, it can set wantCharset to true. If this is done,
* the caller of requestCharset is responsible for calling
* notifyResovedCharset and passing it the final resolved charset and the
* closure that requestCharset set.
*
* @param aWebNavigation the nsIWebNavigation the document is being loaded
* in. May be null.
* @param aChannel the channel the document is coming in from.
* @param aWantCharset gets set to true if notifyResolvedCharset should be
* called with the given closure object.
* @param aClosure a resulting object which should be passed
* to notifyResolvedCharset if wantCharset is set to
* true.
* @returns the resolved charset, or the empty string if no
* charset could be determined.
*/
ACString requestCharset(in nsIWebNavigation aWebNavigation,
in nsIChannel aChannel,
out boolean aWantCharset,
out nsISupports aClosure);
/**
* notifyResolvedCharset
*
* some implementations may request that they be notified when the
* charset is actually detected.
*
* @param charset the detected charset
* @param closure the closre returned by detectCharset() above
*/
void notifyResolvedCharset(in ACString charset, in nsISupports closure);
};