gecko-dev/intl/chardet/public/nsICharsetResolver.idl

84 строки
3.6 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 nsIDocShell;
interface nsIChannel;
[scriptable, uuid(d143a084-b626-4614-845f-41f3ca43a674)]
interface nsICharsetResolver : nsISupports
{
/**
* requestCharset
* called to resolve the charset of an existing docshell.
* If the charset cannot be resolved, but the implementation is
* still curious what the final charset turned out to be, it can
* set wantCharset to true.
* If so, notifyResovedCharset will be called with the resulting
* closure
*
* @param docShell the docshell the document is being loaded in
* @param channel the channel the document is coming in from
* @param charsetSource a unique number which can be stored by the
* caller to remember which resolver actually
* resolved the charset.
* @param wantCharset gets set to true if notifyResolvedCharset should be
* called with the given closure object
* @param closure a resulting object which should be passed
* to notifyResolvedCharset
* @returns the resolved charset, or the empty string if no
* charset could be determined
*/
ACString requestCharset(in nsIDocShell docShell, in nsIChannel channel,
out long charsetSource,
out boolean wantCharset,
out nsISupports closure);
/**
* 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);
};