offapi/com/sun/star/linguistic2/XNumberText.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 spell out numbers and money amounts
  23
  24     <p> The current set of supported languages is:
  25     <ul>
  26         <li>af : Afrikaans</li>
  27         <li>bg : Bulgarian</li>
  28         <li>ca : Catalan</li>
  29         <li>cs : Czech</li>
  30         <li>da : Danish</li>
  31         <li>de : German</li>
  32         <li>de-CH : Swiss Standard German</li>
  33         <li>de-LI : Swiss Standard German</li>
  34         <li>el : Greek</li>
  35         <li>en : English</li>
  36         <li>en-AU : Australian English</li>
  37         <li>en-GB : British English</li>
  38         <li>en-IE : Irish English</li>
  39         <li>en-NZ : New Zealand English</li>
  40         <li>eo : Esperanto</li>
  41         <li>es : Spanish</li>
  42         <li>et : Estonian</li>
  43         <li>fa : Persian (Farsi)</li>
  44         <li>fi : Finnish</li>
  45         <li>fr : French</li>
  46         <li>fr-BE : Belgian French</li>
  47         <li>fr-CH : Swiss French</li>
  48         <li>ga : Irish</li>
  49         <li>gl : Galician</li>
  50         <li>he : Hebrew</li>
  51         <li>hr : Croatian</li>
  52         <li>hu : Hungarian</li>
  53         <li>hu-Hung : Old Hungarian</li>
  54         <li>id : Indonesian</li>
  55         <li>is : Icelandic</li>
  56         <li>it : Italian</li>
  57         <li>ja : Japanese</li>
  58         <li>ko-KP : North-Korean</li>
  59         <li>ko-KR : South-Korean</li>
  60         <li>lb : Luxembourgish</li>
  61         <li>lg : Luganda</li>
  62         <li>lt : Lithuanian</li>
  63         <li>lv : Latvian</li>
  64         <li>mr : Marathi</li>
  65         <li>ms : Malay</li>
  66         <li>mt : Maltese</li>
  67         <li>mul : multiple languages (footnote numbering styles)</li>
  68         <li>nb : Bokmål (Norwegian)</li>
  69         <li>nl : Dutch</li>
  70         <li>nn : Nynorsk (Norwegian)</li>
  71         <li>no : Norwegian (Bokmål)</li>
  72         <li>pl : Polish</li>
  73         <li>pt-BR : Portuguese (Brasilian)</li>
  74         <li>pt-PT : Portuguese (Portugal)</li>
  75         <li>ro : Romanian</li>
  76         <li>Roman : Roman numbers</li>
  77         <li>ru : Russian</li>
  78         <li>sh : Serbian (written with latin characters)</li>
  79         <li>sl : Slovenian</li>
  80         <li>sq : Albanian</li>
  81         <li>sr : Serbian (written with cyrillic characters) (added with OOo 3.4)</li>
  82         <li>Suzhou : Suzhou numerals</li>
  83         <li>sv : Swedish</li>
  84         <li>th : Thai</li>
  85         <li>tr : Turkish</li>
  86         <li>uk : Ukrainian</li>
  87         <li>vi : Vietnamese</li>
  88         <li>zh : Chinese</li>
  89     </ul>
  90
  91     </p>
  92
  93     @since LibreOffice 6.1
  94  */
  95 interface XNumberText
  96 {
  97     /** spell out numbers and money amounts
  98
  99         <p>Please note that text argument can contain prefixes separated by space,
 100         for example "ordinal" for ordinal numbers, "ordinal-number" for ordinal
 101         indicators and ISO 4217 currency codes.
 102
 103         Language modules list the supported prefixes by the input text "help".</p>
 104
 105         @returns
 106             the result of the number name conversion.
 107
 108         @param  aText
 109             all the text including the part that should converted.
 110
 111         @param  aLocale
 112             the locale for the target language of the number name conversion.
 113
 114         @see    com::sun::star::lang::Locale
 115      */
 116     string   getNumberText(
 117             [in] string  aText,
 118             [in] com::sun::star::lang::Locale aLocale )
 119         raises( com::sun::star::lang::IllegalArgumentException );
 120
 121     /** returns a list of all supported languages.
 122     */
 123     sequence< com::sun::star::lang::Locale > getAvailableLanguages();
 124
 125 };
 126
 127 }; }; }; };
 128
 129 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */