1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_util_XNumberFormatTypes_idl__ 24#define __com_sun_star_util_XNumberFormatTypes_idl__ 25 26#ifndef __com_sun_star_uno_XInterface_idl__ 27#include <com/sun/star/uno/XInterface.idl> 28#endif 29 30#ifndef __com_sun_star_lang_Locale_idl__ 31#include <com/sun/star/lang/Locale.idl> 32#endif 33 34 35//============================================================================= 36 37 module com { module sun { module star { module util { 38 39//============================================================================= 40 41/** represents functions to get specific, predefined number formats. 42 */ 43published interface XNumberFormatTypes: com::sun::star::uno::XInterface 44{ 45 //------------------------------------------------------------------------- 46 47 /** @returns 48 the key of the standard format for a locale. 49 */ 50 long getStandardIndex( [in] com::sun::star::lang::Locale nLocale ); 51 52 //------------------------------------------------------------------------- 53 54 /** @returns 55 the key of the standard format within a specified type for a given locale. 56 57 @param nType 58 the type of the number format. Must be one of the 59 <type>NumberFormat</type> constants. 60 */ 61 long getStandardFormat( [in] short nType, 62 [in] com::sun::star::lang::Locale nLocale ); 63 64 //------------------------------------------------------------------------- 65 66 /** @returns 67 the key of a built-in format for a locale: 68 69 @param nIndex 70 the index of the wanted number format within the formats for 71 the given locale. One of the 72 <type scope="com::sun::star::i18n">NumberFormatIndex</type> 73 constants. 74 */ 75 long getFormatIndex( [in] short nIndex, 76 [in] com::sun::star::lang::Locale nLocale ); 77 78 //------------------------------------------------------------------------- 79 80 /** verifies if one type of number format is compatible with another type. 81 */ 82 boolean isTypeCompatible( [in] short nOldType, 83 [in] short nNewType ); 84 85 //------------------------------------------------------------------------- 86 87 /** @returns 88 the index of the converted number format if successful, 89 the old index if the number format could not be converted. 90 91 @param nKey 92 index of the old number format 93 94 @param nLocale 95 the locale to which the number format is converted 96 */ 97 long getFormatForLocale( [in] long nKey, 98 [in] com::sun::star::lang::Locale nLocale ); 99 100}; 101 102//============================================================================= 103 104}; }; }; }; 105 106#endif 107 108