AOO410/main/offapi/com/sun/star/sheet/XSubTotalCalculatable.idl

/**************************************************************
 * 
 * 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_XSubTotalCalculatable_idl__
#define __com_sun_star_sheet_XSubTotalCalculatable_idl__

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

#ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__
#include <com/sun/star/sheet/XSubTotalDescriptor.idl>
#endif

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

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

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

/** contains methods to handle a subtotal descriptor.

	<p>The subtotal descriptor provides properties to set up the subtotal
	function.</p>

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

	/** creates a subtotal descriptor.

		@param bEmpty
			if set to <TRUE/>, creates an empty descriptor. If set to
			<FALSE/>, fills the descriptor with previous settings of the
			current object (i.e. a database range).
	 */
	com::sun::star::sheet::XSubTotalDescriptor createSubTotalDescriptor(
			[in] boolean bEmpty );

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

	/** creates subtotals using the settings of the passed descriptor.

		@param xDescriptor
			the subtotal descriptor with the settings used for the subtotal
			operation.

		@param bReplace
			if set to <TRUE/>, replaces previous subtotal results.
	 */
	void applySubTotals(
			[in] com::sun::star::sheet::XSubTotalDescriptor xDescriptor,
			[in] boolean bReplace );

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

	/** removes the subtotals from the current object.
	 */
	void removeSubTotals();

};

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

}; }; }; };

#endif