xref: /trunk/main/offapi/com/sun/star/sheet/XConsolidatable.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XConsolidatable_idl__
#define __com_sun_star_sheet_XConsolidatable_idl__

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

#ifndef __com_sun_star_sheet_XConsolidationDescriptor_idl__
#include <com/sun/star/sheet/XConsolidationDescriptor.idl>
#endif

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

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

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

/** provides methods to consolidate ranges in a spreadsheet document.

	<p>Consolidation combines the cells of multiple cell ranges, using a
	specific function.</p>

	@deprecated
 */
published interface XConsolidatable: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** creates a consolidation descriptor.

		@param bEmpty
			<TRUE/> leaves the descriptor empty, <FALSE/> fills it with
			the settings from the last consolidation action.

		@see com::sun::star::sheet::ConsolidationDescriptor
	 */
	com::sun::star::sheet::XConsolidationDescriptor createConsolidationDescriptor(
			[in] boolean bEmpty );

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

	/** consolidates data from several cell ranges, using the settings
		in the passed descriptor.

		@param xDescriptor
			the descriptor used to perform the consolidation.

		@see com::sun::star::sheet::ConsolidationDescriptor
	 */
	void consolidate(
			[in] com::sun::star::sheet::XConsolidationDescriptor xDescriptor );

};

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

}; }; }; };

#endif