offapi/com/sun/star/sheet/XMultiFormulaTokens.idl

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