/* -*- 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_i18n_XOrdinalSuffix_idl__
#define __com_sun_star_i18n_XOrdinalSuffix_idl__

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


module com { module sun { module star { module i18n {


/** provides access to locale specific ordinal suffix systems.

    @since OOo 2.2

    @internal

    ATTENTION: This interface is marked <em>internal</em> and does not
    have the <em>published</em> flag, which means it is subject to
    change without notice and should not be used outside the OOo core.
 */

interface XOrdinalSuffix : com::sun::star::uno::XInterface
{
    /** Returns all the possible ordinal suffixes for the number.

        This method will provide "<b>st</b>", "<b>nd</b>", "<b>rd</b>",
        "<b>th</b>" for an English locale, depending on the provided number.
        In some locales like French, Italian or Spanish it ca return several
        suffixes for one number.

        Examples: for the number '1', the values will be <b>st</b> in
        English, but <b>er</b> and <b>re</b> in French. All these values
        may depend on the underlying version of ICU.

     */
    sequence< string > getOrdinalSuffix( [in] long nNumber, [in] com::sun::star::lang::Locale aLocale );
};

}; }; }; };

#endif

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