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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_XMultiFormulaTokens_idl__
  21 #define __com_sun_star_sheet_XMultiFormulaTokens_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/sheet/FormulaToken.idl>
  25 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  26
  27
  28 module com {  module sun {  module star {  module sheet {
  29
  30
  31 /** gives access to multiple sets of formula tokens.
  32
  33     A service implementing this interface can internally set an arbitrary
  34     number of formula token sequences. The number of allowed formula token
  35     sequences must be returned by the
  36     com::sun::star::sheet::XMultiFormulaTokens::getCount()
  37     method. When the client code tries to access formula tokens at index that
  38     is outside the allowed index range, the implementation shall return an
  39     com::sun::star::lang::IndexOutOfBoundsException.
  40  */
  41 interface XMultiFormulaTokens
  42 {
  43
  44     /** returns the formula at specified index as sequence of tokens.
  45
  46         @throws IndexOutOfBoundsException
  47             If the given index lies not in the valid range then an
  48             com::sun::star::lang::IndexOutOfBoundsException
  49             exception is thrown.
  50      */
  51     sequence< FormulaToken > getTokens( [in] long nIndex )
  52         raises (::com::sun::star::lang::IndexOutOfBoundsException);
  53
  54
  55     /** sets the formula at specified index as sequence of tokens.
  56
  57         @throws IndexOutOfBoundsException
  58             If the given index lies not in the valid range then an
  59             com::sun::star::lang::IndexOutOfBoundsException
  60             exception is thrown.
  61      */
  62     void setTokens( [in] long nIndex, [in] sequence< FormulaToken > aTokens )
  63         raises (::com::sun::star::lang::IndexOutOfBoundsException);
  64
  65
  66     /** returns the number of formulas allowed in this formula token set.
  67
  68        @return the number of formulas the implementation supports.
  69      */
  70     long getCount();
  71 };
  72
  73
  74 }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */