/*************************************************************************
 *
 *  $RCSfile: XDataPilotTables.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: hr $ $Date: 2003/03/26 13:56:09 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XDataPilotTables_idl__
#define __com_sun_star_sheet_XDataPilotTables_idl__

#ifndef __com_sun_star_container_XNameAccess_idl__
#include <com/sun/star/container/XNameAccess.idl>
#endif

#ifndef __com_sun_star_sheet_XDataPilotDescriptor_idl__
#include <com/sun/star/sheet/XDataPilotDescriptor.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 access to the data pilot tables via name and inserting and
	removing data pilot tables.

	<p>This interface extends the interface
	<type scope="com::sun::star::container">XNameAccess</type> which provides
	access to existing data pilot tables in the collection.</p>

	@see com::sun::star::sheet::DataPilotTables
	@see com::sun::star::sheet::DataPilotTable
 */
interface XDataPilotTables: com::sun::star::container::XNameAccess
{
	//-------------------------------------------------------------------------

	/** creates a data pilot descriptor.

		<p>This descriptor can be used with
		<member>XDataPilotTables::addTable</member>.</p>

		@see com::sun::star::sheet::DataPilotDescriptor
	 */
	com::sun::star::sheet::XDataPilotDescriptor createDataPilotDescriptor();

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

	/** creates a new data pilot table and adds it to the collection.

		@param aName
			the name of the data pilot table used in the collection.

		@param aAoutputAddress
			the top left cell of the location of the data pilot table in
			the spreadsheet document.

		@param xDescriptor
			the descriptor containing the settings of the data pilot table.

		@see com::sun::star::sheet::DataPilotDescriptor
	 */
	void insertNewByName(
			[in] string aName,
			[in] com::sun::star::table::CellAddress aOutputAddress,
			[in] com::sun::star::sheet::XDataPilotDescriptor xDescriptor );

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

	/** deletes a data pilot table from the collection.
	 */
	void removeByName( [in] string aName );

};

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

}; }; }; };

#endif

