summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/linguistic2/XNumberText.idl
blob: 595e1f1adb5efd60a40dcdb6b1b5dc24c811c1b3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_linguistic2_XNumberText_idl__
#define __com_sun_star_linguistic2_XNumberText_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/Locale.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>

module com { module sun { module star { module linguistic2 {

/** This interface allows to spell out numbers and money amounts

    <p> The current set of supported languages is:
    <ul>
        <li>af : Afrikaans</li>
        <li>bg : Bulgarian</li>
        <li>ca : Catalan</li>
        <li>cs : Czech</li>
        <li>da : Danish</li>
        <li>de : German</li>
        <li>de-CH : Swiss Standard German</li>
        <li>de-LI : Swiss Standard German</li>
        <li>el : Greek</li>
        <li>en : English</li>
        <li>en-AU : Australian English</li>
        <li>en-GB : British English</li>
        <li>en-IE : Irish English</li>
        <li>en-NZ : New Zealand English</li>
        <li>eo : Esperanto</li>
        <li>es : Spanish</li>
        <li>et : Estonian</li>
        <li>fi : Finnish</li>
        <li>fr : French</li>
        <li>fr-BE : Belgian French</li>
        <li>fr-CH : Swiss French</li>
        <li>gl : Galician</li>
        <li>he : Hebrew</li>
        <li>hr : Croatian</li>
        <li>hu : Hungarian</li>
        <li>hu-Hung : Old Hungarian</li>
        <li>id : Indonesian</li>
        <li>is : Icelandic</li>
        <li>it : Italian</li>
        <li>ja : Japanese</li>
        <li>ko-KP : North-Korean</li>
        <li>ko-KR : South-Korean</li>
        <li>lb : Luxembourgish</li>
        <li>lt : Lithuanian</li>
        <li>lv : Latvian</li>
        <li>ms : Malay</li>
        <li>nb : Bokmål (Norwegian)</li>
        <li>nl : Dutch</li>
        <li>nn : Nynorsk (Norwegian)</li>
        <li>no : Norwegian (Bokmål)</li>
        <li>pl : Polish</li>
        <li>pt-BR : Portuguese (Brasilian)</li>
        <li>pt-PT : Portuguese (Portugal)</li>
        <li>ro : Romanian</li>
        <li>Roman : Roman numbers</li>
        <li>ru : Russian</li>
        <li>sh : Serbian (written with latin characters)</li>
        <li>sl : Slovenian</li>
        <li>sq : Albanian</li>
        <li>sr : Serbian (written with cyrillic characters) (added with OOo 3.4)</li>
        <li>Suzhou : Suzhou numerals</li>
        <li>sv : Swedish</li>
        <li>th : Thai</li>
        <li>tr : Turkish</li>
        <li>uk : Ukrainian</li>
        <li>vi : Vietnamese</li>
        <li>zh : Chinese</li>
    </ul>

    </p>

    @since LibreOffice 6.1
 */
interface XNumberText
{
    /** spell out numbers and money amounts

        <p>Please note that text argument can contain prefixes separated by space,
        for example "ordinal" for ordinal numbers, "ordinal-number" for ordinal
        indicators and ISO 4217 currency codes.

        Language modules list the supported prefixes by the input text "help".</p>

        @returns
            the result of the number name conversion.

        @param  aText
            all the text including the part that should converted.

        @param  aLocale
            the locale for the target language of the number name conversion.

        @see    com::sun::star::lang::Locale
     */
    string   getNumberText(
            [in] string  aText,
            [in] com::sun::star::lang::Locale aLocale )
        raises( com::sun::star::lang::IllegalArgumentException );

    /** returns a list of all supported languages.
    */
    sequence< com::sun::star::lang::Locale > getAvailableLanguages();

};

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */