1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_i18n_XExtendedTransliteration_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_i18n_XExtendedTransliteration_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#include <com/sun/star/i18n/XTransliteration.idl> 28*b1cdbd2cSJim Jagielski#include <MultipleCharsOutputException.idl> 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski//============================================================================= 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module i18n { 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski//============================================================================= 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski/** 38*b1cdbd2cSJim Jagielski This interface provides character conversions like case folding or 39*b1cdbd2cSJim Jagielski Hiragana to Katakana. 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski <p> It is derived from 42*b1cdbd2cSJim Jagielski <type scope="::com::sun::star::i18n">XTransliteration</type> and provides 43*b1cdbd2cSJim Jagielski additional functionality for character to character and 44*b1cdbd2cSJim Jagielski string to string without offset parameter transliteration. These 45*b1cdbd2cSJim Jagielski should be used for performance reason if their full-blown 46*b1cdbd2cSJim Jagielski counterparts aren't neded. </p> 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski @since OpenOffice 1.1.2 49*b1cdbd2cSJim Jagielski */ 50*b1cdbd2cSJim Jagielskipublished interface XExtendedTransliteration : ::com::sun::star::i18n::XTransliteration 51*b1cdbd2cSJim Jagielski{ 52*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------ 53*b1cdbd2cSJim Jagielski /** Transliterate a substring. The functionality is the same as 54*b1cdbd2cSJim Jagielski <member scope="::com::sun::star::i18n">XTransliteration::transliterate()</member> 55*b1cdbd2cSJim Jagielski but omits the offset prameter to improve performance. 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski @param aStr 58*b1cdbd2cSJim Jagielski The input string. 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski @param nStartPos 61*b1cdbd2cSJim Jagielski Start position within aStr from where transliteration starts. 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski @param nCount 64*b1cdbd2cSJim Jagielski Number of codepoints to be transliterated. 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski */ 67*b1cdbd2cSJim Jagielski string transliterateString2String( [in] string aStr, 68*b1cdbd2cSJim Jagielski [in] long nStartPos, [in] long nCount ); 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------ 72*b1cdbd2cSJim Jagielski /** Transliterate a character to a string. 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski @param cChar 75*b1cdbd2cSJim Jagielski The input character. 76*b1cdbd2cSJim Jagielski */ 77*b1cdbd2cSJim Jagielski string transliterateChar2String( [in] char cChar ); 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------ 80*b1cdbd2cSJim Jagielski /** Transliterate a character to a character. 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski <p> If the output contains multiple characters, for example when 83*b1cdbd2cSJim Jagielski transliterating German sharp 's' (the one that looks like a 84*b1cdbd2cSJim Jagielski Greek Beta) to upper case "SS", MultipleCharsOutputException 85*b1cdbd2cSJim Jagielski will be thrown, the caller must catch the exception and then 86*b1cdbd2cSJim Jagielski call 87*b1cdbd2cSJim Jagielski <method>XTransliteration::transliterateChar2String()</method> to 88*b1cdbd2cSJim Jagielski obtain the correct result. </p> 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski @param cChar 91*b1cdbd2cSJim Jagielski The input character. 92*b1cdbd2cSJim Jagielski */ 93*b1cdbd2cSJim Jagielski char transliterateChar2Char( [in] char cChar ) 94*b1cdbd2cSJim Jagielski raises( MultipleCharsOutputException ); 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski}; 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski//============================================================================= 99*b1cdbd2cSJim Jagielski}; }; }; }; 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski#endif 102