diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
commit | ed5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch) | |
tree | 7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/util/XNumberFormats.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.zip |
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | offapi/com/sun/star/util/XNumberFormats.idl | 179 |
1 files changed, 179 insertions, 0 deletions
diff --git a/offapi/com/sun/star/util/XNumberFormats.idl b/offapi/com/sun/star/util/XNumberFormats.idl new file mode 100644 index 000000000..8e4bcbe69 --- /dev/null +++ b/offapi/com/sun/star/util/XNumberFormats.idl @@ -0,0 +1,179 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_util_XNumberFormats_idl__ +#define __com_sun_star_util_XNumberFormats_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/beans/XPropertySet.idl> + +#include <com/sun/star/lang/Locale.idl> + +#include <com/sun/star/util/MalformedNumberFormatException.idl> + + + + module com { module sun { module star { module util { + + +/** provides access to multiple NumberFormats. + + The number formats are managed by their unique key in the document. + */ +published interface XNumberFormats: com::sun::star::uno::XInterface +{ + + /** @returns + a readonly NumberFormatProperties. + + @param nKey + the key for the format + */ + com::sun::star::beans::XPropertySet getByKey( [in] long nKey ); + + + /** @returns + a sequence of the keys of all number formats with the specified type and language. + + @param nType + the type of number formats to return. Must be one of the + NumberFormat constants. + + @param nLocale + the locale of number formats to return. + + @param bCreate + `TRUE`: create new entries if no formats for the selected language exist<BR> + `FALSE`: return an empty list if no formats for the selected language exist + */ + sequence<long> queryKeys( [in] short nType, + [in] com::sun::star::lang::Locale nLocale, + [in] boolean bCreate ); + + + /** finds a number format by its format string and returns its key. + + @returns + the key for the format if found, otherwise -1. + + @param aFormat + the string representation of the number format + + @param nLocale + the locale for number formats to find + + @param bScan + reserved for future use and should be set to false + */ + long queryKey( [in] string aFormat, + [in] com::sun::star::lang::Locale nLocale, + [in] boolean bScan ); + + + /** adds a new number format to the list, using a format string. + + @returns + the key for new number format + + @param aFormat + the string representation of the number format + + @param nLocale + the locale for the number format + + @throws com::sun::star::util::MalformedNumberFormatException + if incorrect number format is specified + */ + long addNew( [in] string aFormat, + [in] com::sun::star::lang::Locale nLocale ) + raises( com::sun::star::util::MalformedNumberFormatException ); + + + /** adds a new number format to the list, using a format + string in a different locale than the desired locale of the + resulting number format. + + @returns + the key for added number format + + @param aFormat + the key for the number format + + @param nLocale + the original locale for the number format + + @param nNewLocale + the new locale for the number format to be converted + + @throws com::sun::star::util::MalformedNumberFormatException + if incorrect number format is specified + */ + long addNewConverted( [in] string aFormat, + [in] com::sun::star::lang::Locale nLocale, + [in] com::sun::star::lang::Locale nNewLocale ) + raises( com::sun::star::util::MalformedNumberFormatException ); + + + /** removes a number format from the list. + + @param nKey + the key for the numberformat + */ + void removeByKey( [in] long nKey ); + + + /** generates a format string from several parameters without + creating an actual number format. + + @returns + the string representation for the number format + + @param nBaseKey + the key for the number format to be used as base format + + @param nLocale + the locale for the number format + + @param bThousands + the thousands separator is shown or not + + @param bRed + show negative number in red colored if `TRUE` + + @param nDecimals + how many digits are shown after the decimal point + + @param nLeading + how many number of leading zeros are shown + */ + string generateFormat( [in] long nBaseKey, + [in] com::sun::star::lang::Locale nLocale, + [in] boolean bThousands, + [in] boolean bRed, + [in] short nDecimals, + [in] short nLeading ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |