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/sheet/XExternalSheetCache.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-upstream.tar.xz libreoffice-upstream.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 'offapi/com/sun/star/sheet/XExternalSheetCache.idl')
-rw-r--r-- | offapi/com/sun/star/sheet/XExternalSheetCache.idl | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/XExternalSheetCache.idl b/offapi/com/sun/star/sheet/XExternalSheetCache.idl new file mode 100644 index 000000000..d386bf4dc --- /dev/null +++ b/offapi/com/sun/star/sheet/XExternalSheetCache.idl @@ -0,0 +1,92 @@ +/* -*- 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_sheet_XExternalSheetCache_idl__ +#define __com_sun_star_sheet_XExternalSheetCache_idl__ + +#include <com/sun/star/lang/IllegalArgumentException.idl> + +module com { module sun { module star { module sheet { + +/** Primary interface for the com::sun::star::sheet::ExternalSheetCache service. + + @see com::sun::star::sheet::ExternalSheetCache + + @since OOo 3.1 + */ +interface XExternalSheetCache +{ + /** It sets a cached value for a specified cell position. The value is expected + to be either of type string or of type double. No + other data types are supported. + + @param nRow row position (0-based) + @param nColumn column position (0-based) + @param aValue cell value to be cached + */ + void setCellValue( [in] long nColumn, [in] long nRow, [in] any aValue ) + raises (com::sun::star::lang::IllegalArgumentException); + + /** It retrieves a cached value from a specified cell position. The cached + value can be either string or double. + + @return any cached cell value + */ + any getCellValue( [in] long nColumn, [in] long nRow ) + raises (com::sun::star::lang::IllegalArgumentException); + + /** It returns a list of all row numbers where a cached cell or cells exist. + The row numbers are sorted in ascending order. + + @return sequence<long> list of all row numbers with cached cell(s) + */ + sequence< long > getAllRows(); + + /** Given a row number, this method returns a list of all columns numbers + that store cached cell values in that row. The column numbers are + sorted in ascending order. + + @return sequence<long> list of all columns numbers with cached cell values + */ + sequence< long > getAllColumns( [in] long nRow ) + raises (com::sun::star::lang::IllegalArgumentException); + + + /** Index corresponding to this instance of an external sheet cache for + usage in formula tokens. + + <p>This index to the external sheet cache is expected in the + SingleReference::Sheet member if it is part of an + external reference token. + + <p>Each external sheet cache has a unique index value inside the + ExternalDocLink instance.</p> + + @see FormulaToken + @see ExternalReference + */ + [attribute, readonly] long TokenIndex; + +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |