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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_i18n_XExtendedTransliteration_idl__
  21 #define __com_sun_star_i18n_XExtendedTransliteration_idl__
  22
  23 #include <com/sun/star/i18n/XTransliteration.idl>
  24 #include <com/sun/star/i18n/MultipleCharsOutputException.idl>
  25
  26
  27 module com { module sun { module star { module i18n {
  28
  29
  30
  31 /**
  32     This interface provides character conversions like case folding or
  33     Hiragana to Katakana.
  34
  35     <p> It is derived from
  36     ::com::sun::star::i18n::XTransliteration and provides
  37     additional functionality for character to character and
  38     string to string without offset parameter transliteration. These
  39     should be used for performance reason if their full-blown
  40     counterparts aren't needed.  </p>
  41
  42      @since OOo 1.1.2
  43  */
  44 published interface XExtendedTransliteration : ::com::sun::star::i18n::XTransliteration
  45 {
  46     /** Transliterate a substring. The functionality is the same as
  47         ::com::sun::star::i18n::XTransliteration::transliterate()
  48         but omits the offset parameter to improve performance.
  49
  50         @param aStr
  51             The input string.
  52
  53         @param nStartPos
  54             Start position within aStr from where transliteration starts.
  55
  56         @param nCount
  57             Number of code points to be transliterated.
  58
  59      */
  60     string  transliterateString2String( [in] string aStr,
  61             [in] long nStartPos, [in] long nCount );
  62
  63
  64     /** Transliterate a character to a string.
  65
  66         @param cChar
  67             The input character.
  68      */
  69     string  transliterateChar2String( [in] char cChar );
  70
  71     /** Transliterate a character to a character.
  72
  73         <p> If the output contains multiple characters, for example when
  74         transliterating German sharp "s" (the one that looks like a
  75         Greek Beta) to upper case "SS", MultipleCharsOutputException
  76         will be thrown, the caller must catch the exception and then
  77         call
  78         XTransliteration::transliterateChar2String() to
  79         obtain the correct result. </p>
  80
  81         @param cChar
  82             The input character.
  83      */
  84     char    transliterateChar2Char( [in] char cChar )
  85                 raises( MultipleCharsOutputException );
  86
  87 };
  88
  89 }; }; }; };
  90
  91 #endif
  92
  93 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */