blob: 23827d7a04e24971d498820b1f9c8d151f43c04a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#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 <type scope="com::sun::star::sheet">ExternalSheetCache</type> service.
@see com::sun::star::sheet::ExternalSheetCache
@since OOo 3.1.0
*/
interface XExternalSheetCache
{
/** It sets a cached value for a specified cell position. The value is expected
to be either of type <type>string</type> or of type <type>double</type>. 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 <type>string</type> or <type>double</type>.
@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
<member>SingleReference::Sheet</member> member if it is part of an
external reference token.
<p>Each external sheet cache has a unique index value inside the
<type>ExternalDocLink</type> instance.</p>
@see FormulaToken
@see ExternalReference
*/
[attribute, readonly] long TokenIndex;
};
}; }; }; };
#endif
|
