1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef INCLUDED_com_sun_star_i18n_XOrdinalSuffix_idl
25#define INCLUDED_com_sun_star_i18n_XOrdinalSuffix_idl
26
27#include <com/sun/star/lang/Locale.idl>
28
29//============================================================================
30
31module com { module sun { module star { module i18n {
32
33//============================================================================
34
35/** provides access to locale specific ordinal suffix systems.
36
37    @since OOo 2.2
38
39    @internal
40
41    ATTENTION: This interface is marked <em>internal</em> and does not
42    have the <em>published</em> flag, which means it is subject to
43    change without notice and should not be used outside the OOo core.
44    The current version is a draft and works only for English language
45    locales. Future enhancements adding functionality for other locales
46    should use the 'ordinal' RuleBasedNumberFormat of the ICU if
47    possible, see
48    http://icu.sourceforge.net/apiref/icu4c/classRuleBasedNumberFormat.html
49    which might make it necessary to change the interface.
50 */
51
52interface XOrdinalSuffix : com::sun::star::uno::XInterface
53{
54    //------------------------------------------------------------------------
55    /** Returns the ordinal suffix for the number, for example,
56        "<b>st</b>", "<b>nd</b>", "<b>rd</b>", "<b>th</b>"
57        in an English locale.
58     */
59    string getOrdinalSuffix( [in] long nNumber, [in] com::sun::star::lang::Locale aLocale );
60};
61
62//============================================================================
63}; }; }; };
64//============================================================================
65
66#endif
67