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

   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 __com_sun_star_i18n_XNativeNumberSupplier_idl__
  29 #define __com_sun_star_i18n_XNativeNumberSupplier_idl__
  30
  31 #include <com/sun/star/lang/Locale.idl>
  32 #include <NativeNumberXmlAttributes.idl>
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module i18n {
  37
  38 //=============================================================================
  39
  40 /** Methods to convert between strings of ASCII Arabic digits and native
  41     numeral strings.
  42
  43      @since OOo 1.1.2
  44  */
  45
  46 published interface XNativeNumberSupplier : ::com::sun::star::uno::XInterface
  47 {
  48     //-------------------------------------------------------------------------
  49     /** Returns native number string for given number string.
  50
  51         @param nNativeNumberMode
  52             One of <type>NativeNumberMode</type> values.
  53      */
  54
  55     string getNativeNumberString( [in] string aNumberString,
  56                     [in] ::com::sun::star::lang::Locale aLocale,
  57                     [in] short nNativeNumberMode );
  58
  59     //-------------------------------------------------------------------------
  60     /** Check if the NatNum is valid for the given locale.
  61
  62         @param nNativeNumberMode
  63             One of <type>NativeNumberMode</type> values.
  64      */
  65
  66     boolean isValidNatNum( [in] ::com::sun::star::lang::Locale aLocale,
  67                     [in] short nNativeNumberMode );
  68
  69     //-------------------------------------------------------------------------
  70     /** Convert a specific NatNum/Locale combination to attributes used
  71         in the XML file format.
  72
  73         @param nNativeNumberMode
  74             One of <type>NativeNumberMode</type> values.
  75      */
  76
  77     NativeNumberXmlAttributes convertToXmlAttributes(
  78             [in] ::com::sun::star::lang::Locale aLocale,
  79             [in] short nNativeNumberMode );
  80
  81     //-------------------------------------------------------------------------
  82     /** Convert XML attributes to a NatNum value.
  83
  84         @returns
  85             One of <type>NativeNumberMode</type>
  86      */
  87
  88     short convertFromXmlAttributes( [in] NativeNumberXmlAttributes aAttr );
  89
  90 };
  91
  92 //=============================================================================
  93 }; }; }; };
  94
  95 #endif