offapi/com/sun/star/linguistic2/XLanguageGuessing.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 module com { module sun { module star { module linguistic2 {
  21
  22 /** This interface allows to guess the language of a text
  23
  24     <p> The current set of supported languages is:
  25     <ul>
  26         <li>af : Afrikaans</li>
  27         <li>am : Amharic</li>
  28         <li>ar : Arabic</li>
  29         <li>be : Belarus</li>
  30         <li>br : Breton</li>
  31         <li>bs : Bosnian</li>
  32         <li>ca : Catalan</li>
  33         <li>cs : Czech</li>
  34         <li>cy : Welsh</li>
  35         <li>da : Danish</li>
  36         <li>de : German</li>
  37         <li>drt : Drents</li>
  38         <li>el : Greek</li>
  39         <li>en : English</li>
  40         <li>eo : Esperanto</li>
  41         <li>es : Spanish</li>
  42         <li>et : Estonian</li>
  43         <li>eu : Basque</li>
  44         <li>fa : Persian</li>
  45         <li>fi : Finnish</li>
  46         <li>fr : French</li>
  47         <li>fy : Frisian</li>
  48         <li>ga : Irish Gaelic</li>
  49         <li>gd : Scots Gaelic</li>
  50         <li>gv : Manx Gaelic</li>
  51         <li>he : Hebrew</li>
  52         <li>hi : Hindi</li>
  53         <li>hr : Croatian</li>
  54         <li>hu : Hungarian</li>
  55         <li>hy : Armenian</li>
  56         <li>id : Indonesian</li>
  57         <li>is : Icelandic</li>
  58         <li>it : Italian</li>
  59         <li>ja : Japanese</li>
  60         <li>ka : Georgian</li>
  61         <li>ko : Korean</li>
  62         <li>la : Latin</li>
  63         <li>lb : Luxembourgish (added with OOo 3.3)</li>
  64         <li>lt : Lithuanian</li>
  65         <li>lv : Latvian</li>
  66         <li>mr : Marathi</li>
  67         <li>ms : Malay</li>
  68         <li>ne : Nepali</li>
  69         <li>nl : Dutch</li>
  70         <li>nb : Norwegian (Bokmal)</li>
  71         <li>pl : Polish</li>
  72         <li>pt-PT : Portuguese (Portugal)</li>
  73         <li>qu : Quechua</li>
  74         <li>rm : Romansh</li>
  75         <li>ro : Romanian</li>
  76         <li>ru : Russian</li>
  77         <li>sa : Sanskrit</li>
  78         <li>sco : Scots</li>
  79         <li>sh : Serbian (written with latin characters)</li>
  80         <li>sk-SK : Slovak (written with Latin characters)</li>
  81         <li>sl : Slovenian</li>
  82         <li>sq : Albanian</li>
  83         <li>sr : Serbian (written with cyrillic characters) (added with OOo 3.4)</li>
  84         <li>sv : Swedish</li>
  85         <li>sw : Swahili</li>
  86         <li>ta : Tamil</li>
  87         <li>th : Thai</li>
  88         <li>tl : Tagalog</li>
  89         <li>tr : Turkish</li>
  90         <li>uk : Ukrainian</li>
  91         <li>vi : Vietnamese</li>
  92         <li>yi : Yiddish</li>
  93         <li>zh-CN : Chinese (simplified)</li>
  94         <li>zh-TW : Chinese (traditional)</li>
  95     </ul>
  96
  97     </p>
  98
  99     @since OOo 2.2
 100  */
 101 interface XLanguageGuessing
 102 {
 103     /** determines the single most probable language of a sub-string.
 104
 105         <p>Please note that because statistical analysis is part
 106         of the algorithm the likelihood to get the correct
 107         result increases with the length of the sub-string.
 108         A word is much less likely guessed correctly compared to
 109         a sentence or even a whole paragraph.</p>
 110
 111         <p>Also note that some languages are that "close" to each other
 112         that it will be quite unlikely to find a difference in them,
 113         e.g. English (UK), English (IE) and English (AUS) and
 114         most likely English (US) as well. And thus the result may
 115         be arbitrary.</p>
 116
 117         @returns
 118             the locale for the language identified.
 119             If no language could be identified the locale will be empty.
 120
 121         @param  aText
 122             all the text including the part that should checked.
 123
 124         @param nStartPos
 125             specifies the starting index of the sub-string to be checked
 126             The value must met 0 <= nStartPos < (length of text - 1).
 127
 128         @param nLen
 129             specifies the length of the sub-string to be checked.
 130             The value must met 0 <= nLen <= (length of text).
 131
 132         @see    com::sun::star::lang::Locale
 133      */
 134     com::sun::star::lang::Locale    guessPrimaryLanguage(
 135             [in] string  aText,
 136             [in] long    nStartPos,
 137             [in] long    nLen )
 138         raises( com::sun::star::lang::IllegalArgumentException );
 139
 140     /** allows to explicitly discard some languages from the set of
 141         languages possibly returned.
 142
 143         <p>By default all languages are enabled.</p>
 144     */
 145     void disableLanguages(
 146             [in] sequence< com::sun::star::lang::Locale > aLanguages )
 147         raises( com::sun::star::lang::IllegalArgumentException );
 148
 149     /** allows to explicitly re-enable some languages that got previously
 150         disabled.
 151
 152         <p>By default all languages are enabled.</p>
 153     */
 154     void enableLanguages(
 155             [in] sequence< com::sun::star::lang::Locale > aLanguages )
 156         raises( com::sun::star::lang::IllegalArgumentException );
 157
 158     /** returns a list of all supported languages.
 159
 160         <p>This should be the same as the mathematical union of
 161         all enabled and disabled languages.</p>
 162     */
 163     sequence< com::sun::star::lang::Locale > getAvailableLanguages();
 164
 165     /** returns the list of all enabled languages
 166     */
 167     sequence< com::sun::star::lang::Locale > getEnabledLanguages();
 168
 169     /** returns the list of all disabled languages
 170     */
 171     sequence< com::sun::star::lang::Locale > getDisabledLanguages();
 172
 173 };
 174
 175 }; }; }; };
 176
 177 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */