offapi/com/sun/star/i18n/XExtendedTransliteration.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XExtendedTransliteration.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_i18n_XExtendedTransliteration_idl__
  32 #define __com_sun_star_i18n_XExtendedTransliteration_idl__
  33
  34 #include <com/sun/star/i18n/XTransliteration.idl>
  35 #include <MultipleCharsOutputException.idl>
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module i18n {
  40
  41 //=============================================================================
  42
  43
  44 /**
  45     This interface provides character conversions like case folding or
  46     Hiragana to Katakana.
  47
  48     <p> It is derived from
  49     <type scope="::com::sun::star::i18n">XTransliteration</type> and provides
  50     additional functionality for character to character and
  51     string to string without offset parameter transliteration. These
  52     should be used for performance reason if their full-blown
  53     counterparts aren't neded.  </p>
  54
  55      @since OOo 1.1.2
  56  */
  57 published interface XExtendedTransliteration : ::com::sun::star::i18n::XTransliteration
  58 {
  59     //------------------------------------------------------------------------
  60     /** Transliterate a substring. The functionality is the same as
  61         <member scope="::com::sun::star::i18n">XTransliteration::transliterate()</member>
  62         but omits the offset prameter to improve performance.
  63
  64         @param aStr
  65             The input string.
  66
  67         @param nStartPos
  68             Start position within aStr from where transliteration starts.
  69
  70         @param nCount
  71             Number of codepoints to be transliterated.
  72
  73      */
  74     string  transliterateString2String( [in] string aStr,
  75             [in] long nStartPos, [in] long nCount );
  76
  77
  78     //------------------------------------------------------------------------
  79     /** Transliterate a character to a string.
  80
  81         @param cChar
  82             The input character.
  83      */
  84     string  transliterateChar2String( [in] char cChar );
  85
  86     //------------------------------------------------------------------------
  87     /** Transliterate a character to a character.
  88
  89         <p> If the output contains multiple characters, for example when
  90         transliterating German sharp 's' (the one that looks like a
  91         Greek Beta) to upper case "SS", MultipleCharsOutputException
  92         will be thrown, the caller must catch the exception and then
  93         call
  94         <method>XTransliteration::transliterateChar2String()</method> to
  95         obtain the correct result. </p>
  96
  97         @param cChar
  98             The input character.
  99      */
 100     char    transliterateChar2Char( [in] char cChar )
 101                 raises( MultipleCharsOutputException );
 102
 103 };
 104
 105 //=============================================================================
 106 }; }; }; };
 107
 108 #endif