offapi/com/sun/star/i18n/XOrdinalSuffix.idl

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