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