include/comphelper/numbers.hxx

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