LibreOffice LibreOffice 25.2 SDK API Reference

XNumberFormatter.idl
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
21
22 module com { module sun { module star { module util {
23
24
27published interface XNumberFormatter: com::sun::star::uno::XInterface
28{
29
37 void attachNumberFormatsSupplier( [in] com::sun::star::util::XNumberFormatsSupplier xSupplier );
38
39
43 com::sun::star::util::XNumberFormatsSupplier getNumberFormatsSupplier();
44
45
48 long detectNumberFormat( [in] long nKey,
49 [in] string aString )
50 raises( com::sun::star::util::NotNumericException );
51
52
57 double convertStringToNumber( [in] long nKey,
58 [in] string aString )
59 raises( com::sun::star::util::NotNumericException );
60
61
64 string convertNumberToString( [in] long nKey,
65 [in] double fValue );
66
67
72 com::sun::star::util::Color queryColorForNumber( [in] long nKey,
73 [in] double fValue,
74 [in] com::sun::star::util::Color aDefaultColor );
75
76
79 string formatString( [in] long nKey,
80 [in] string aString );
81
82
87 com::sun::star::util::Color queryColorForString( [in] long nKey,
88 [in] string aString,
89 [in] com::sun::star::util::Color aDefaultColor );
90
91
98 string getInputString( [in] long nKey,
99 [in] double fValue );
100
101};
102
103
104}; }; }; };
105
106/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::util::NotNumericException
indicates that a non-numeric string is to be converted to a number.
Definition: NotNumericException.idl:28
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com::sun::star::util::XNumberFormatsSupplier
supplies the collection of NumberFormats (for example, in a document) and the settings belonging to t...
Definition: XNumberFormatsSupplier.idl:29
com::sun::star::util::XNumberFormatter
represents a number formatter.
Definition: XNumberFormatter.idl:28
com::sun::star::util::XNumberFormatter::detectNumberFormat
long detectNumberFormat([in] long nKey, [in] string aString)
detects the number format in a string which contains a formatted number.
com::sun::star::util::XNumberFormatter::convertStringToNumber
double convertStringToNumber([in] long nKey, [in] string aString)
converts a string which contains a formatted number into a number.
com::sun::star::util::XNumberFormatter::formatString
string formatString([in] long nKey, [in] string aString)
converts a string into another string.
com::sun::star::util::XNumberFormatter::convertNumberToString
string convertNumberToString([in] long nKey, [in] double fValue)
converts a number into a string.
com::sun::star::util::XNumberFormatter::attachNumberFormatsSupplier
void attachNumberFormatsSupplier([in] com::sun::star::util::XNumberFormatsSupplier xSupplier)
attaches an XNumberFormatsSupplier to this NumberFormatter.
com::sun::star::util::XNumberFormatter::getNumberFormatsSupplier
com::sun::star::util::XNumberFormatsSupplier getNumberFormatsSupplier()
com::sun::star::util::XNumberFormatter::queryColorForString
com::sun::star::util::Color queryColorForString([in] long nKey, [in] string aString, [in] com::sun::star::util::Color aDefaultColor)
com::sun::star::util::XNumberFormatter::getInputString
string getInputString([in] long nKey, [in] double fValue)
converts a number into a string with the specified format.
com::sun::star::util::XNumberFormatter::queryColorForNumber
com::sun::star::util::Color queryColorForNumber([in] long nKey, [in] double fValue, [in] com::sun::star::util::Color aDefaultColor)
com::sun::star::util::Color
long Color
describes an RGB color value with an optional alpha channel.
Definition: Color.idl:34
com
Definition: Ambiguous.idl:20