LibreOffice Module comphelper (master)  1
numbers.cxx
Go to the documentation of this file.
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 #include <comphelper/numbers.hxx>
21 #include <osl/diagnose.h>
22 #include <sal/log.hxx>
23 #include <com/sun/star/util/NumberFormat.hpp>
24 #include <com/sun/star/util/XNumberFormatter.hpp>
25 #include <com/sun/star/beans/XPropertySet.hpp>
26 
27 
28 namespace comphelper
29 {
30 
31 sal_Int16 getNumberFormatType(const css::uno::Reference<css::util::XNumberFormats>& xFormats, sal_Int32 nKey)
32 {
33  sal_Int16 nReturn(css::util::NumberFormat::UNDEFINED);
34  if (xFormats.is())
35  {
36  try
37  {
38  css::uno::Reference<css::beans::XPropertySet> xFormat(xFormats->getByKey(nKey));
39  if (xFormat.is())
40  xFormat->getPropertyValue("Type") >>= nReturn;
41  }
42  catch(...)
43  {
44  SAL_WARN("comphelper", "getNumberFormatType : invalid key! (maybe created with another formatter ?)");
45  }
46  }
47  return nReturn;
48 }
49 
50 
51 sal_Int16 getNumberFormatType(const css::uno::Reference<css::util::XNumberFormatter>& xFormatter, sal_Int32 nKey)
52 {
53  OSL_ENSURE(xFormatter.is(), "getNumberFormatType : the formatter isn't valid !");
54  css::uno::Reference<css::util::XNumberFormatsSupplier> xSupplier( xFormatter->getNumberFormatsSupplier());
55  OSL_ENSURE(xSupplier.is(), "getNumberFormatType : the formatter doesn't implement a supplier !");
56  css::uno::Reference<css::util::XNumberFormats> xFormats( xSupplier->getNumberFormats());
57  return getNumberFormatType(xFormats, nKey);
58 }
59 
60 
61 css::uno::Any getNumberFormatDecimals(const css::uno::Reference<css::util::XNumberFormats>& xFormats, sal_Int32 nKey)
62 {
63  if (xFormats.is())
64  {
65  try
66  {
67  css::uno::Reference<css::beans::XPropertySet> xFormat( xFormats->getByKey(nKey));
68  if (xFormat.is())
69  {
70  return xFormat->getPropertyValue( "Decimals" );
71  }
72  }
73  catch(...)
74  {
75  SAL_WARN("comphelper", "getNumberFormatDecimals : invalid key! (may be created with another formatter ?)");
76  }
77  }
78  return css::uno::Any(sal_Int16(0));
79 }
80 
81 
82 using namespace ::com::sun::star::uno;
83 using namespace ::com::sun::star::util;
84 using namespace ::com::sun::star::beans;
85 
86 
87 Any getNumberFormatProperty( const Reference< XNumberFormatter >& _rxFormatter, sal_Int32 _nKey, const OUString& _rPropertyName )
88 {
89  Any aReturn;
90 
91  OSL_ENSURE( _rxFormatter.is() && !_rPropertyName.isEmpty(), "getNumberFormatProperty: invalid arguments!" );
92  try
93  {
94  Reference< XNumberFormatsSupplier > xSupplier;
95  Reference< XNumberFormats > xFormats;
96  Reference< XPropertySet > xFormatProperties;
97 
98  if ( _rxFormatter.is() )
99  xSupplier = _rxFormatter->getNumberFormatsSupplier();
100  if ( xSupplier.is() )
101  xFormats = xSupplier->getNumberFormats();
102  if ( xFormats.is() )
103  xFormatProperties = xFormats->getByKey( _nKey );
104 
105  if ( xFormatProperties.is() )
106  aReturn = xFormatProperties->getPropertyValue( _rPropertyName );
107  }
108  catch( const Exception& )
109  {
110  OSL_FAIL( "::getNumberFormatProperty: caught an exception (did you create the key with another formatter?)!" );
111  }
112 
113  return aReturn;
114 }
115 
116 
117 } // namespace comphelper
118 
119 
120 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
sal_Int16 getNumberFormatType(const css::uno::Reference< css::util::XNumberFormats > &xFormats, sal_Int32 nKey)
returns the css::util::NumberFormat of the given key under the given formats
Definition: numbers.cxx:31
css::uno::Any getNumberFormatDecimals(const css::uno::Reference< css::util::XNumberFormats > &xFormats, sal_Int32 nKey)
returns the decimals of the given numeric number formatunder the given formats
Definition: numbers.cxx:61
#define SAL_WARN(area, stream)
Any getNumberFormatProperty(const Reference< XNumberFormatter > &_rxFormatter, sal_Int32 _nKey, const OUString &_rPropertyName)
Definition: numbers.cxx:87