Songbird / Development / Songbird Add-Ons API Documentation

components/intl/public/sbIStringTransform.idl

00001 /*
00002 //
00003 // BEGIN SONGBIRD GPL
00004 //
00005 // This file is part of the Songbird web player.
00006 //
00007 // Copyright(c) 2005-2008 POTI, Inc.
00008 // http://songbirdnest.com
00009 //
00010 // This file may be licensed under the terms of of the
00011 // GNU General Public License Version 2 (the "GPL").
00012 //
00013 // Software distributed under the License is distributed
00014 // on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
00015 // express or implied. See the GPL for the specific language
00016 // governing rights and limitations.
00017 //
00018 // You should have received a copy of the GPL along with this
00019 // program. If not, go to http://www.gnu.org/licenses/gpl.html
00020 // or write to the Free Software Foundation, Inc.,
00021 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00022 //
00023 // END SONGBIRD GPL
00024 //
00025 */
00026 
00027 #include "nsISupports.idl"
00028 
00032 [scriptable, uuid(4b9a60a0-76e8-47ed-b701-b297d45ab95e)]
00033 interface sbIStringTransform : nsISupports
00034 {
00039   const unsigned long TRANSFORM_MAP_HIRAGANA = 1;
00044   const unsigned long TRANSFORM_MAP_KATAKANA = 1 << 1;
00045 
00049   const unsigned long TRANSFORM_LOWERCASE = 1 << 4;
00053   const unsigned long TRANSFORM_UPPERCASE = 1 << 5;
00054 
00059   const unsigned long TRANSFORM_SIMPLIFIED_CHINESE = 1 << 6;
00064   const unsigned long TRANSFORM_TRADITIONAL_CHINESE = 1 << 7;
00065 
00070   const unsigned long TRANSFORM_IGNORE_SYMBOLS = 1 << 8;
00071 
00076   const unsigned long TRANSFORM_IGNORE_NONSPACE = 1 << 9;
00077 
00078   const unsigned long TRANSFORM_REVERSE_BYTES = 1 << 11; 
00079 
00083   const unsigned long TRANSFORM_IGNORE_NONALPHANUM = 1 << 12;
00084   const unsigned long TRANSFORM_IGNORE_NONALPHANUM_IGNORE_SPACE = 1 << 13;
00085 
00091   const unsigned long TRANSFORM_IGNORE_LEADING = 1 << 14;
00092 
00096   const unsigned long TRANSFORM_IGNORE_KEEPNUMBERSYMBOLS = 1 << 15;
00097 
00098   AString normalizeString(in AString aCharset,
00099                           in unsigned long aTransformFlags,
00100                           in AString aInput);
00101 
00102   AString convertToCharset(in AString aDestCharset,
00103                            in AString aInput);
00104 
00105   AString guessCharset(in AString aInput);
00106   
00107   AString removeArticles(in AString aInput, [optional] in AString aLanguage);
00108 };
00109 
00110 %{C++
00111 
00112 #define SB_STRINGTRANSFORM_DESCRIPTION    \
00113   "Songbird String Transform"
00114 #define SB_STRINGTRANSFORM_CONTRACTID     \
00115   "@songbirdnest.com/Songbird/Intl/StringTransform;1"
00116 #define SB_STRINGTRANSFORM_CLASSNAME      \
00117   "sbStringTransform"
00118 #define SB_STRINGTRANSFORM_CID            \
00119 { /*{0a8d2a48-2947-4ee4-bf36-32e7777358db}*/ \
00120   0xa8d2a48,                                 \
00121   0x2947,                                    \
00122   0x4ee4,                                    \
00123   { 0xbf, 0x36, 0x32, 0xe7, 0x77, 0x73, 0x58, 0xdb } \
00124 }
00125 
00126 %}

Generated on Tue Mar 10 14:28:54 2009 for Songbird by  doxygen 1.5.2