intl/chardet/public/nsIDocCharset.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2001
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Brian Stell <bstell@netscape.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 /**
  42  * The nsIDocCharset interface allows the user to view,
  43  * hint, and set which converter is used to read the document's
  44  * data.
  45  *
  46  * <P>Inside Mozilla all text is encoded as Unicode. By standardizing
  47  * on Unicode every piece of code that handles characters no longer
  48  * needs to:
  49  *
  50  *     Have access to a character encoding parameter.
  51  *     Ask is the data stateful?
  52  *     Ask is the data single byte?
  53  *     Ask is the data multi-byte?
  54  *     If multi-byte: have access to a routine that can
  55  *         determine how many bytes in the current character.
  56  *
  57  * When the document is read in a converter is used to convert
  58  * the document's data to Unicode.
  59  *
  60  * nsIDocCharset provides the ability to:
  61  *
  62  *   See what converter was used when inputting the documents
  63  *   data.
  64  *
  65  *   Override the character set for documents where the specified
  66  *   fallback, or auto-detected character set is incorrect
  67  *
  68  */
  69 [scriptable, uuid(9c18bb4e-1dd1-11b2-bf91-9cc82c275823)]
  70 interface nsIDocCharset : nsISupports
  71 {
  72
  73     /**
  74      * Get/sets the encoding (converter) used to read the
  75      * document. Get returns the encoding used. Set forces
  76      * (overrides) the encoding. After forcing the charset the
  77      * embedding application will need to cause the data to be
  78      * reparsed in order to update the DOM / display.
  79      *
  80      * A force also sets the fallback encoding for this frame.
  81      */
  82     attribute string charset;
  83
  84 };
  85
  86