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
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** gives access to multiple sets of formula tokens.
  25
  26     A service implementing this interface can internally set an arbitrary
  27     number of formula token sequences. The number of allowed formula token
  28     sequences must be returned by the
  29     com::sun::star::sheet::XMultiFormulaTokens::getCount()
  30     method. When the client code tries to access formula tokens at index that
  31     is outside the allowed index range, the implementation shall return an
  32     com::sun::star::lang::IndexOutOfBoundsException.
  33  */
  34 interface XMultiFormulaTokens
  35 {
  36
  37     /** returns the formula at specified index as sequence of tokens.
  38
  39         @throws IndexOutOfBoundsException
  40             If the given index lies not in the valid range then an
  41             com::sun::star::lang::IndexOutOfBoundsException
  42             exception is thrown.
  43      */
  44     sequence< FormulaToken > getTokens( [in] long nIndex )
  45         raises (::com::sun::star::lang::IndexOutOfBoundsException);
  46
  47
  48     /** sets the formula at specified index as sequence of tokens.
  49
  50         @throws IndexOutOfBoundsException
  51             If the given index lies not in the valid range then an
  52             com::sun::star::lang::IndexOutOfBoundsException
  53             exception is thrown.
  54      */
  55     void setTokens( [in] long nIndex, [in] sequence< FormulaToken > aTokens )
  56         raises (::com::sun::star::lang::IndexOutOfBoundsException);
  57
  58
  59     /** returns the number of formulas allowed in this formula token set.
  60
  61        @return the number of formulas the implementation supports.
  62      */
  63     long getCount();
  64 };
  65
  66
  67 }; }; }; };
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */