xref: /aoo41x/main/offapi/com/sun/star/sheet/XDataPilotTables.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_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
 */
published 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