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