1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef INCLUDED_com_sun_star_i18n_XOrdinalSuffix_idl
29#define INCLUDED_com_sun_star_i18n_XOrdinalSuffix_idl
30
31#include <com/sun/star/lang/Locale.idl>
32
33//============================================================================
34
35module com { module sun { module star { module i18n {
36
37//============================================================================
38
39/** provides access to locale specific ordinal suffix systems.
40
41    @since OOo 2.2
42
43    @internal
44
45    ATTENTION: This interface is marked <em>internal</em> and does not
46    have the <em>published</em> flag, which means it is subject to
47    change without notice and should not be used outside the OOo core.
48    The current version is a draft and works only for English language
49    locales. Future enhancements adding functionality for other locales
50    should use the 'ordinal' RuleBasedNumberFormat of the ICU if
51    possible, see
52    http://icu.sourceforge.net/apiref/icu4c/classRuleBasedNumberFormat.html
53    which might make it necessary to change the interface.
54 */
55
56interface XOrdinalSuffix : com::sun::star::uno::XInterface
57{
58    //------------------------------------------------------------------------
59    /** Returns the ordinal suffix for the number, for example,
60        "<b>st</b>", "<b>nd</b>", "<b>rd</b>", "<b>th</b>"
61        in an English locale.
62     */
63    string getOrdinalSuffix( [in] long nNumber, [in] com::sun::star::lang::Locale aLocale );
64};
65
66//============================================================================
67}; }; }; };
68//============================================================================
69
70#endif
71