xref: /AOO41X/main/comphelper/inc/comphelper/numbers.hxx (revision 9877b273795ec465a3ce9c15d738eb34c0455705)
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 
24 #ifndef _COMPHELPER_NUMBERS_HXX_
25 #define _COMPHELPER_NUMBERS_HXX_
26 
27 #include <com/sun/star/util/XNumberFormats.hpp>
28 #include <com/sun/star/util/XNumberFormatter.hpp>
29 #include <com/sun/star/lang/Locale.hpp>
30 #include "comphelper/comphelperdllapi.h"
31 
32 //.........................................................................
33 namespace comphelper
34 {
35 //.........................................................................
36 
37     namespace staruno   = ::com::sun::star::uno;
38     namespace starlang  = ::com::sun::star::lang;
39     namespace starutil  = ::com::sun::star::util;
40 
41     /// returns the ::com::sun::star::util::NumberFormat of the given key under the given formats
42     COMPHELPER_DLLPUBLIC sal_Int16 getNumberFormatType(const staruno::Reference<starutil::XNumberFormats>& xFormats, sal_Int32 nKey);
43 
44     /// returns the ::com::sun::star::util::NumberFormat of the given key under the given formatter
45     COMPHELPER_DLLPUBLIC sal_Int16 getNumberFormatType(const staruno::Reference<starutil::XNumberFormatter>& xFormatter, sal_Int32 nKey);
46 
47     /// returns the decimals of the given numeric number formatunder the given formats
48     COMPHELPER_DLLPUBLIC staruno::Any getNumberFormatDecimals(const staruno::Reference<starutil::XNumberFormats>& xFormats, sal_Int32 nKey);
49 
50     /** returns the standard format for the given type and the given _rLocale
51     */
52     sal_Int32 getStandardFormat(
53             const staruno::Reference<starutil::XNumberFormatter>& xFormatter,
54             sal_Int16 nType,
55             const starlang::Locale& _rLocale);
56 
57     /** retrieves a the value of a given property for a given format key, relating to a given formatter
58     */
59     COMPHELPER_DLLPUBLIC ::com::sun::star::uno::Any getNumberFormatProperty(
60         const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter >& _rxFormatter,
61         sal_Int32 _nKey,
62         const rtl::OUString& _rPropertyName
63     );
64 
65 //.........................................................................
66 }   // namespace comphelper
67 //.........................................................................
68 
69 #endif // _COMPHELPER_NUMBERS_HXX_
70 
71