1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
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.
14 *
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).
20 *
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.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_sheet_XMultiFormulaTokens_idl__
29#define __com_sun_star_sheet_XMultiFormulaTokens_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35#ifndef __com_sun_star_sheet_FormulaToken_idl__
36#include <com/sun/star/sheet/FormulaToken.idl>
37#endif
38
39#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
40#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
41#endif
42
43//=============================================================================
44
45module com {  module sun {  module star {  module sheet {
46
47//=============================================================================
48
49/** gives access to multiple sets of formula tokens.
50
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>.
58 */
59interface XMultiFormulaTokens
60{
61    //-------------------------------------------------------------------------
62
63    /** returns the formula at specified index as sequence of tokens.
64
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.
69     */
70    sequence< FormulaToken > getTokens( [in] long nIndex )
71        raises (::com::sun::star::lang::IndexOutOfBoundsException);
72
73    //-------------------------------------------------------------------------
74
75    /** sets the formula at specified index as sequence of tokens.
76
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.
81     */
82    void setTokens( [in] long nIndex, [in] sequence< FormulaToken > aTokens )
83        raises (::com::sun::star::lang::IndexOutOfBoundsException);
84
85    //-------------------------------------------------------------------------
86
87    /** returns the number of formulas allowed in this formula token set.
88
89       @return the number of formulas the implementation supports.
90     */
91    long getCount();
92};
93
94//=============================================================================
95
96}; }; }; };
97
98#endif
99
100