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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module i18n {
  22
  23
  24 /** provides access to locale specific ordinal suffix systems.
  25
  26     @since OOo 2.2
  27
  28     @internal
  29
  30     ATTENTION: This interface is marked <em>internal</em> and does not
  31     have the <em>published</em> flag, which means it is subject to
  32     change without notice and should not be used outside the OOo core.
  33  */
  34
  35 interface XOrdinalSuffix : com::sun::star::uno::XInterface
  36 {
  37     /** Returns all the possible ordinal suffixes for the number.
  38
  39         This method will provide "<b>st</b>", "<b>nd</b>", "<b>rd</b>",
  40         "<b>th</b>" for an English locale, depending on the provided number.
  41         In some locales like French, Italian or Spanish it ca return several
  42         suffixes for one number.
  43
  44         Examples: for the number '1', the values will be <b>st</b> in
  45         English, but <b>er</b> and <b>re</b> in French. All these values
  46         may depend on the underlying version of ICU.
  47
  48      */
  49     sequence< string > getOrdinalSuffix( [in] long nNumber, [in] com::sun::star::lang::Locale aLocale );
  50 };
  51
  52 }; }; }; };
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */