1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/intl/unicharutil/idl/nsISaveAsCharset.idl Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,52 @@
1.4 +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
1.5 +/* This Source Code Form is subject to the terms of the Mozilla Public
1.6 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.7 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.8 +
1.9 +#include "nsISupports.idl"
1.10 +#include "nsIEntityConverter.idl"
1.11 +
1.12 +%{C++
1.13 +#define NS_SAVEASCHARSET_CID { 0xcd233e0, 0x7a86, 0x11d3, { 0x91, 0x5c, 0x0, 0x60, 0x8, 0xa6, 0xed, 0xf6 } }
1.14 +#define NS_SAVEASCHARSET_CONTRACTID "@mozilla.org/intl/saveascharset;1"
1.15 +%}
1.16 +
1.17 +[scriptable, uuid(33B87F70-7A9C-11d3-915C-006008A6EDF6)]
1.18 +interface nsISaveAsCharset : nsISupports
1.19 +{
1.20 + // attributes
1.21 + const unsigned long mask_Fallback = 0x000000FF; // mask for fallback (8bits)
1.22 + const unsigned long mask_Entity = 0x00000300; // mask for entity (2bits)
1.23 + const unsigned long mask_CharsetFallback = 0x00000400; // mask for charset fallback (1bit)
1.24 +
1.25 + const unsigned long attr_FallbackNone = 0; // no fall back for unconverted chars (skipped)
1.26 + const unsigned long attr_FallbackQuestionMark = 1; // unconverted chars are replaced by '?'
1.27 + const unsigned long attr_FallbackEscapeU = 2; // unconverted chars are escaped as \uxxxx
1.28 + const unsigned long attr_FallbackDecimalNCR = 3; // unconverted chars are replaced by decimal NCR
1.29 + const unsigned long attr_FallbackHexNCR = 4; // unconverted chars are replaced by hex NCR
1.30 +
1.31 + const unsigned long attr_EntityNone = 0; // generate no Named Entity
1.32 + const unsigned long attr_EntityBeforeCharsetConv = 0x00000100; // generate Named Entity before charset conversion
1.33 + const unsigned long attr_EntityAfterCharsetConv = 0x00000200; // generate Named Entity after charset conversion
1.34 +
1.35 + const unsigned long attr_CharsetFallback = 0x00000400; // fallback to other charset and restart the convesion
1.36 +
1.37 +
1.38 + // default attribute for plain text
1.39 + const unsigned long attr_plainTextDefault = attr_FallbackNone + attr_EntityNone;
1.40 +
1.41 + // default attribute for html text
1.42 + // generate entity before charset conversion, use decimal NCR
1.43 + const unsigned long attr_htmlTextDefault = attr_FallbackDecimalNCR + attr_EntityBeforeCharsetConv;
1.44 +
1.45 + readonly attribute string charset; // charset used for the conversion
1.46 +
1.47 + // set up charset, attribute and entity version
1.48 + // see nsIEntityConverter.idl for possible value of entityVersion (entityNone for plain text).
1.49 + void Init(in string charset, in unsigned long attr, in unsigned long entityVersion);
1.50 +
1.51 + // convert UCS-2 html to target charset
1.52 + // may return the result code of the unicode converter (NS_ERROR_UENC_NOMAPPING)
1.53 + // if the attribute does not specify any fall back (e.g. attrPlainTextDefault)
1.54 + string Convert(in wstring inString);
1.55 +};
