intl/unicharutil/idl/nsIEntityConverter.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) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 %{C++
  41 // {9E9B565A-8E52-4C1A-8805-B2B91655F874}
  42 #define NS_ENTITYCONVERTER_CID { 0x9e9b565a, 0x8e52, 0x4c1a, {0x88, 0x05, 0xb2, 0xb9, 0x16, 0x55, 0xf8, 0x74}}
  43 #define NS_ENTITYCONVERTER_CONTRACTID "@mozilla.org/intl/entityconverter;1"
  44 %}
  45
  46 [scriptable, uuid(D14C7111-55E0-11d3-91D9-00105AA3F7DC)]
  47 interface nsIEntityConverter : nsISupports
  48 {
  49   const unsigned long entityNone = 0;
  50   const unsigned long html40Latin1 = 1;
  51   const unsigned long html40Symbols = 2;
  52   const unsigned long html40Special = 4;                       // excludes &quot, &amp, &lt, &gt
  53   const unsigned long transliterate = 8;
  54   const unsigned long mathml20 = 16;
  55   const unsigned long html32 = html40Latin1;
  56   const unsigned long html40 = html40Latin1+html40Symbols+html40Special;
  57   const unsigned long entityW3C = html40+mathml20;
  58
  59   string ConvertUTF32ToEntity(in unsigned long character, in unsigned long entityVersion);
  60   string ConvertToEntity(in wchar character, in unsigned long entityVersion);
  61
  62   wstring ConvertToEntities(in wstring inString, in unsigned long entityVersion);
  63 };