Back to index

lightning-sunbird  0.9+nobinonly
nsIEntityConverter.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsISupports.idl"
00039 
00040 %{C++
00041 // {9E9B565A-8E52-4C1A-8805-B2B91655F874}
00042 #define NS_ENTITYCONVERTER_CID { 0x9e9b565a, 0x8e52, 0x4c1a, {0x88, 0x05, 0xb2, 0xb9, 0x16, 0x55, 0xf8, 0x74}}
00043 #define NS_ENTITYCONVERTER_CONTRACTID "@mozilla.org/intl/entityconverter;1"
00044 %}
00045 
00046 [scriptable, uuid(D14C7111-55E0-11d3-91D9-00105AA3F7DC)]
00047 interface nsIEntityConverter : nsISupports
00048 {
00049   const unsigned long entityNone = 0;
00050   const unsigned long html40Latin1 = 1;
00051   const unsigned long html40Symbols = 2;
00052   const unsigned long html40Special = 4;                       // excludes &quot, &amp, &lt, &gt
00053   const unsigned long transliterate = 8;
00054   const unsigned long mathml20 = 16;
00055   const unsigned long html32 = html40Latin1;
00056   const unsigned long html40 = html40Latin1+html40Symbols+html40Special;
00057   const unsigned long entityW3C = html40+mathml20;
00058 
00059   string ConvertUTF32ToEntity(in unsigned long character, in unsigned long entityVersion);
00060   string ConvertToEntity(in wchar character, in unsigned long entityVersion);
00061 
00062   wstring ConvertToEntities(in wstring inString, in unsigned long entityVersion);
00063 };