← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/intl/unicharutil/idl/nsISaveAsCharset.idl

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/intl/unicharutil/idl/nsISaveAsCharset.idl
 
1
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
 
2
/* ***** BEGIN LICENSE BLOCK *****
 
3
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 
4
 *
 
5
 * The contents of this file are subject to the Netscape Public License
 
6
 * Version 1.1 (the "License"); you may not use this file except in
 
7
 * compliance with the License. You may obtain a copy of the License at
 
8
 * http://www.mozilla.org/NPL/
 
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
 *
 
25
 * Alternatively, the contents of this file may be used under the terms of
 
26
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 
27
 * 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 NPL, 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 NPL, the GPL or the LGPL.
 
36
 *
 
37
 * ***** END LICENSE BLOCK ***** */
 
38
 
 
39
#include "nsISupports.idl"
 
40
#include "nsIEntityConverter.idl"
 
41
 
 
42
%{C++
 
43
#define NS_SAVEASCHARSET_CID { 0xcd233e0, 0x7a86, 0x11d3, { 0x91, 0x5c, 0x0, 0x60, 0x8, 0xa6, 0xed, 0xf6 } }
 
44
#define NS_SAVEASCHARSET_CONTRACTID "@mozilla.org/intl/saveascharset;1"
 
45
%}
 
46
 
 
47
[scriptable, uuid(33B87F70-7A9C-11d3-915C-006008A6EDF6)]
 
48
interface nsISaveAsCharset : nsISupports
 
49
{
 
50
  // attributes
 
51
  const unsigned long mask_Fallback                = 0x000000FF; // mask for fallback (8bits)
 
52
  const unsigned long mask_Entity                  = 0x00000300; // mask for entity (2bits)
 
53
  const unsigned long mask_CharsetFallback         = 0x00000400; // mask for charset fallback (1bit)
 
54
  const unsigned long mask_IgnorableFallback       = 0x00000800; // mask for ignorable code points (1bit)
 
55
 
 
56
  const unsigned long attr_FallbackNone = 0;                   // no fall back for unconverted chars (skipped)
 
57
  const unsigned long attr_FallbackQuestionMark = 1;           // unconverted chars are replaced by '?'
 
58
  const unsigned long attr_FallbackEscapeU = 2;                // unconverted chars are escaped as \uxxxx
 
59
  const unsigned long attr_FallbackDecimalNCR = 3;             // unconverted chars are replaced by decimal NCR
 
60
  const unsigned long attr_FallbackHexNCR = 4;                 // unconverted chars are replaced by hex NCR
 
61
 
 
62
  const unsigned long attr_EntityNone = 0;                       // generate no Named Entity
 
63
  const unsigned long attr_EntityBeforeCharsetConv = 0x00000100; // generate Named Entity before charset conversion
 
64
  const unsigned long attr_EntityAfterCharsetConv =  0x00000200; // generate Named Entity after charset conversion
 
65
 
 
66
  const unsigned long attr_CharsetFallback        =  0x00000400; // fallback to other charset and restart the convesion
 
67
 
 
68
  const unsigned long attr_IgnoreIgnorables       =  0x00000800; // turn default ignorable code points (and Hebrew/Arabic/Syriac Vowel signs to nothingness
 
69
 
 
70
                                                               // default attribute for plain text
 
71
  const unsigned long attr_plainTextDefault = attr_FallbackNone + attr_EntityNone;               
 
72
  
 
73
                                                               // default attribute for html text
 
74
                                                               // generate entity before charset conversion, use decimal NCR
 
75
  const unsigned long attr_htmlTextDefault = attr_FallbackDecimalNCR + attr_EntityBeforeCharsetConv;
 
76
 
 
77
  readonly attribute string charset;                           // charset used for the conversion
 
78
 
 
79
  // set up charset, attribute and entity version 
 
80
  // see nsIEntityConverter.idl for possible value of entityVersion (entityNone for plain text).
 
81
  void Init(in string charset, in unsigned long attr, in unsigned long entityVersion);
 
82
 
 
83
  // convert UCS-2 html to target charset
 
84
  // may return the result code of the unicode converter (NS_ERROR_UENC_NOMAPPING)
 
85
  // if the attribute does not specify any fall back (e.g. attrPlainTextDefault)
 
86
        string Convert(in wstring inString);
 
87
};