LibreOffice LibreOffice 25.8 SDK API Reference

XNumberFormats.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
29published interface XNumberFormats: com::sun::star::uno::XInterface
30{
31
38 com::sun::star::beans::XPropertySet getByKey( [in] long nKey );
39
40
55 sequence<long> queryKeys( [in] short nType,
56 [in] com::sun::star::lang::Locale nLocale,
57 [in] boolean bCreate );
58
59
74 long queryKey( [in] string aFormat,
75 [in] com::sun::star::lang::Locale nLocale,
76 [in] boolean bScan );
77
78
93 long addNew( [in] string aFormat,
94 [in] com::sun::star::lang::Locale nLocale )
95 raises( com::sun::star::util::MalformedNumberFormatException );
96
97
117 long addNewConverted( [in] string aFormat,
118 [in] com::sun::star::lang::Locale nLocale,
119 [in] com::sun::star::lang::Locale nNewLocale )
120 raises( com::sun::star::util::MalformedNumberFormatException );
121
122
128 void removeByKey( [in] long nKey );
129
130
155 string generateFormat( [in] long nBaseKey,
156 [in] com::sun::star::lang::Locale nLocale,
157 [in] boolean bThousands,
158 [in] boolean bRed,
159 [in] short nDecimals,
160 [in] short nLeading );
161
162};
163
164
165}; }; }; };
166
167/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::util::MalformedNumberFormatException
is thrown when a NumberFormat string is syntactically incorrect.
Definition: MalformedNumberFormatException.idl:29
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:46
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com::sun::star::util::XNumberFormats
provides access to multiple NumberFormats.
Definition: XNumberFormats.idl:30
com::sun::star::util::XNumberFormats::queryKeys
sequence< long > queryKeys([in] short nType, [in] com::sun::star::lang::Locale nLocale, [in] boolean bCreate)
com::sun::star::util::XNumberFormats::generateFormat
string generateFormat([in] long nBaseKey, [in] com::sun::star::lang::Locale nLocale, [in] boolean bThousands, [in] boolean bRed, [in] short nDecimals, [in] short nLeading)
generates a format string from several parameters without creating an actual number format.
com::sun::star::util::XNumberFormats::addNew
long addNew([in] string aFormat, [in] com::sun::star::lang::Locale nLocale)
adds a new number format to the list, using a format string.
com::sun::star::util::XNumberFormats::queryKey
long queryKey([in] string aFormat, [in] com::sun::star::lang::Locale nLocale, [in] boolean bScan)
finds a number format by its format string and returns its key.
com::sun::star::util::XNumberFormats::getByKey
com::sun::star::beans::XPropertySet getByKey([in] long nKey)
com::sun::star::util::XNumberFormats::removeByKey
void removeByKey([in] long nKey)
removes a number format from the list.
com::sun::star::util::XNumberFormats::addNewConverted
long addNewConverted([in] string aFormat, [in] com::sun::star::lang::Locale nLocale, [in] com::sun::star::lang::Locale nNewLocale)
adds a new number format to the list, using a format string in a different locale than the desired lo...
com
Definition: Ambiguous.idl:20
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:34