/**************************************************************
 * 
 * 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_XSheetOperation_idl__
#define __com_sun_star_sheet_XSheetOperation_idl__

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

#ifndef __com_sun_star_sheet_GeneralFunction_idl__
#include <com/sun/star/sheet/GeneralFunction.idl>
#endif

#ifndef __com_sun_star_uno_Exception_idl__
#include <com/sun/star/uno/Exception.idl>
#endif

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

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

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

/** provides methods to execute operations on a cell range or ranges.

	@see com::sun::star::sheet::SheetCellRange
	@see com::sun::star::sheet::SheetCellRanges
 */
published interface XSheetOperation: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** computes a general function based on all cells in the current
		cell range(s).

		@param nFunction
			is the function used to compute the result.

		@returns
			the result of the calculation.
	 */
	double computeFunction(
			[in] com::sun::star::sheet::GeneralFunction nFunction )
		raises( com::sun::star::uno::Exception );	//! unnecessary

	//-------------------------------------------------------------------------

	/** clears the specified contents of the current cell range(s).

		@param nContentFlags
			a combination of <type>CellFlags</type> flags selecting the
			contents to be deleted.
	 */
	void clearContents( [in] long nContentFlags );

};

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

}; }; }; };

#endif