/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_sheet_XMultiFormulaTokens_idl__
#define __com_sun_star_sheet_XMultiFormulaTokens_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/sheet/FormulaToken.idl>
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>


module com {  module sun {  module star {  module sheet {


/** gives access to multiple sets of formula tokens.

    A service implementing this interface can internally set an arbitrary
    number of formula token sequences. The number of allowed formula token
    sequences must be returned by the
    com::sun::star::sheet::XMultiFormulaTokens::getCount()
    method. When the client code tries to access formula tokens at index that
    is outside the allowed index range, the implementation shall return an
    com::sun::star::lang::IndexOutOfBoundsException.
 */
interface XMultiFormulaTokens
{

    /** returns the formula at specified index as sequence of tokens.

        @throws IndexOutOfBoundsException
            If the given index lies not in the valid range then an
            com::sun::star::lang::IndexOutOfBoundsException
            exception is thrown.
     */
    sequence< FormulaToken > getTokens( [in] long nIndex )
        raises (::com::sun::star::lang::IndexOutOfBoundsException);


    /** sets the formula at specified index as sequence of tokens.

        @throws IndexOutOfBoundsException
            If the given index lies not in the valid range then an
            com::sun::star::lang::IndexOutOfBoundsException
            exception is thrown.
     */
    void setTokens( [in] long nIndex, [in] sequence< FormulaToken > aTokens )
        raises (::com::sun::star::lang::IndexOutOfBoundsException);


    /** returns the number of formulas allowed in this formula token set.

       @return the number of formulas the implementation supports.
     */
    long getCount();
};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
