xref: /aoo42x/main/offapi/com/sun/star/sheet/XMultipleOperation.idl (revision d1766043)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_sheet_XMultipleOperation_idl__
#define __com_sun_star_sheet_XMultipleOperation_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_table_CellRangeAddress_idl__
#include <com/sun/star/table/CellRangeAddress.idl>
#endif

#ifndef __com_sun_star_sheet_TableOperationMode_idl__
#include <com/sun/star/sheet/TableOperationMode.idl>
#endif

#ifndef __com_sun_star_table_CellAddress_idl__
#include <com/sun/star/table/CellAddress.idl>
#endif

//=============================================================================

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

//=============================================================================

/** provides a method to apply a Multiple Operations Table to the
	cell range.
 */
published interface XMultipleOperation: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** creates a table of formulas (a "Multiple Operations Table").

		<p>The specified formulas are repeated, with references to the
		specified cells replaced by references to values in the first
		column and/or row of the range.</p>

		@param aFormulaRange
			the range that contains formula cells (modes
			<const>TableOperationMode::ROW</const> or
			<const>TableOperationMode::COLUMN</const>) or a single formula
			cell (mode <const>TableOperationMode::BOTH</const>).

		@param nMode
			specifies the calculation mode to fill the cells.

		@param aColumnCell
			contains the address of the cell that is referenced by
			formulas in a row (mode <const>TableOperationMode::ROW</const>)
			or by the formula cell used for two value series (mode
			<const>TableOperationMode::BOTH</const>). This parameter is not
			used if mode is <const>TableOperationMode::COLUMN</const>.

		@param aRowCell
			contains the address of the cell that is referenced by
			formulas in a column (mode <const>TableOperationMode::COLUMN</const>)
			or by the formula cell used for two value series (mode
			<const>TableOperationMode::BOTH</const>). This parameter is not
			used if mode is <const>TableOperationMode::ROW</const>.
	 */
	void setTableOperation(
			[in] com::sun::star::table::CellRangeAddress aFormulaRange,
			[in] com::sun::star::sheet::TableOperationMode nMode,
			[in] com::sun::star::table::CellAddress aColumnCell,
			[in] com::sun::star::table::CellAddress aRowCell );

};

//=============================================================================

}; }; }; };

#endif