merged tag ooo/OOO330_m14
[LibreOffice.git] / offapi / com / sun / star / sheet / XMultiFormulaTokens.idl
blobeb6ade5c3883aab49d8aa85ef9d87827feab4492
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * This file is part of OpenOffice.org.
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org. If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
26 ************************************************************************/
28 #ifndef __com_sun_star_sheet_XMultiFormulaTokens_idl__
29 #define __com_sun_star_sheet_XMultiFormulaTokens_idl__
31 #ifndef __com_sun_star_uno_XInterface_idl__
32 #include <com/sun/star/uno/XInterface.idl>
33 #endif
35 #ifndef __com_sun_star_sheet_FormulaToken_idl__
36 #include <com/sun/star/sheet/FormulaToken.idl>
37 #endif
39 #ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
40 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
41 #endif
43 //=============================================================================
45 module com { module sun { module star { module sheet {
47 //=============================================================================
49 /** gives access to multiple sets of formula tokens.
51 A service implementing this interface can internally set an arbitrary
52 number of formula token sequences. The number of allowed formula token
53 sequences must be returned by the
54 <member scope="com::sun::star::sheet">XMultiFormulaTokens::getCount</member>
55 method. When the client code tries to access formula tokens at index that
56 is outside the allowed index range, the implementation shall return an
57 <type scope="com::sun::star::lang">IndexOutOfBoundsException</member>.
59 interface XMultiFormulaTokens
61 //-------------------------------------------------------------------------
63 /** returns the formula at specified index as sequence of tokens.
65 @throws IndexOutOfBoundsException
66 If the given index lies not in the valid range then an
67 <type scope="com::sun::star::lang">IndexOutOfBoundsException</type>
68 exception is thrown.
70 sequence< FormulaToken > getTokens( [in] long nIndex )
71 raises (::com::sun::star::lang::IndexOutOfBoundsException);
73 //-------------------------------------------------------------------------
75 /** sets the formula at specified index as sequence of tokens.
77 @throws IndexOutOfBoundsException
78 If the given index lies not in the valid range then an
79 <type scope="com::sun::star::lang">IndexOutOfBoundsException</type>
80 exception is thrown.
82 void setTokens( [in] long nIndex, [in] sequence< FormulaToken > aTokens )
83 raises (::com::sun::star::lang::IndexOutOfBoundsException);
85 //-------------------------------------------------------------------------
87 /** returns the number of formulas allowed in this formula token set.
89 @return the number of formulas the implementation supports.
91 long getCount();
94 //=============================================================================
96 }; }; }; };
98 #endif