1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_XDataPilotTables_idl__
25#define __com_sun_star_sheet_XDataPilotTables_idl__
26
27#ifndef __com_sun_star_container_XNameAccess_idl__
28#include <com/sun/star/container/XNameAccess.idl>
29#endif
30
31#ifndef __com_sun_star_sheet_XDataPilotDescriptor_idl__
32#include <com/sun/star/sheet/XDataPilotDescriptor.idl>
33#endif
34
35#ifndef __com_sun_star_table_CellAddress_idl__
36#include <com/sun/star/table/CellAddress.idl>
37#endif
38
39//=============================================================================
40
41module com {  module sun {  module star {  module sheet {
42
43//=============================================================================
44
45/** provides access to the data pilot tables via name and inserting and
46	removing data pilot tables.
47
48	<p>This interface extends the interface
49	<type scope="com::sun::star::container">XNameAccess</type> which provides
50	access to existing data pilot tables in the collection.</p>
51
52	@see com::sun::star::sheet::DataPilotTables
53	@see com::sun::star::sheet::DataPilotTable
54 */
55published interface XDataPilotTables: com::sun::star::container::XNameAccess
56{
57	//-------------------------------------------------------------------------
58
59	/** creates a data pilot descriptor.
60
61		<p>This descriptor can be used with
62		<member>XDataPilotTables::addTable</member>.</p>
63
64		@see com::sun::star::sheet::DataPilotDescriptor
65	 */
66	com::sun::star::sheet::XDataPilotDescriptor createDataPilotDescriptor();
67
68	//-------------------------------------------------------------------------
69
70	/** creates a new data pilot table and adds it to the collection.
71
72		@param aName
73			the name of the data pilot table used in the collection.
74
75		@param aAoutputAddress
76			the top left cell of the location of the data pilot table in
77			the spreadsheet document.
78
79		@param xDescriptor
80			the descriptor containing the settings of the data pilot table.
81
82		@see com::sun::star::sheet::DataPilotDescriptor
83	 */
84	void insertNewByName(
85			[in] string aName,
86			[in] com::sun::star::table::CellAddress aOutputAddress,
87			[in] com::sun::star::sheet::XDataPilotDescriptor xDescriptor );
88
89	//-------------------------------------------------------------------------
90
91	/** deletes a data pilot table from the collection.
92	 */
93	void removeByName( [in] string aName );
94
95};
96
97//=============================================================================
98
99}; }; }; };
100
101#endif
102
103