Back to index

lightning-sunbird  0.9+nobinonly
nsISaveAsCharset.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 #include "nsIEntityConverter.idl"
00040 
00041 %{C++
00042 #define NS_SAVEASCHARSET_CID { 0xcd233e0, 0x7a86, 0x11d3, { 0x91, 0x5c, 0x0, 0x60, 0x8, 0xa6, 0xed, 0xf6 } }
00043 #define NS_SAVEASCHARSET_CONTRACTID "@mozilla.org/intl/saveascharset;1"
00044 %}
00045 
00046 [scriptable, uuid(33B87F70-7A9C-11d3-915C-006008A6EDF6)]
00047 interface nsISaveAsCharset : nsISupports
00048 {
00049   // attributes
00050   const unsigned long mask_Fallback                = 0x000000FF; // mask for fallback (8bits)
00051   const unsigned long mask_Entity                  = 0x00000300; // mask for entity (2bits)
00052   const unsigned long mask_CharsetFallback         = 0x00000400; // mask for charset fallback (1bit)
00053   const unsigned long mask_IgnorableFallback       = 0x00000800; // mask for ignorable code points (1bit)
00054 
00055   const unsigned long attr_FallbackNone = 0;                   // no fall back for unconverted chars (skipped)
00056   const unsigned long attr_FallbackQuestionMark = 1;           // unconverted chars are replaced by '?'
00057   const unsigned long attr_FallbackEscapeU = 2;                // unconverted chars are escaped as \uxxxx
00058   const unsigned long attr_FallbackDecimalNCR = 3;             // unconverted chars are replaced by decimal NCR
00059   const unsigned long attr_FallbackHexNCR = 4;                 // unconverted chars are replaced by hex NCR
00060 
00061   const unsigned long attr_EntityNone = 0;                       // generate no Named Entity
00062   const unsigned long attr_EntityBeforeCharsetConv = 0x00000100; // generate Named Entity before charset conversion
00063   const unsigned long attr_EntityAfterCharsetConv =  0x00000200; // generate Named Entity after charset conversion
00064 
00065   const unsigned long attr_CharsetFallback        =  0x00000400; // fallback to other charset and restart the convesion
00066 
00067   const unsigned long attr_IgnoreIgnorables       =  0x00000800; // turn default ignorable code points (and Hebrew/Arabic/Syriac Vowel signs to nothingness
00068 
00069                                                                // default attribute for plain text
00070   const unsigned long attr_plainTextDefault = attr_FallbackNone + attr_EntityNone;               
00071   
00072                                                                // default attribute for html text
00073                                                                // generate entity before charset conversion, use decimal NCR
00074   const unsigned long attr_htmlTextDefault = attr_FallbackDecimalNCR + attr_EntityBeforeCharsetConv;
00075 
00076   readonly attribute string charset;                           // charset used for the conversion
00077 
00078   // set up charset, attribute and entity version 
00079   // see nsIEntityConverter.idl for possible value of entityVersion (entityNone for plain text).
00080   void Init(in string charset, in unsigned long attr, in unsigned long entityVersion);
00081 
00082   // convert UCS-2 html to target charset
00083   // may return the result code of the unicode converter (NS_ERROR_UENC_NOMAPPING)
00084   // if the attribute does not specify any fall back (e.g. attrPlainTextDefault)
00085        string Convert(in wstring inString);
00086 };