1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_sheet_XDataPilotTables_idl__
29#define __com_sun_star_sheet_XDataPilotTables_idl__
30
31#ifndef __com_sun_star_container_XNameAccess_idl__
32#include <com/sun/star/container/XNameAccess.idl>
33#endif
34
35#ifndef __com_sun_star_sheet_XDataPilotDescriptor_idl__
36#include <com/sun/star/sheet/XDataPilotDescriptor.idl>
37#endif
38
39#ifndef __com_sun_star_table_CellAddress_idl__
40#include <com/sun/star/table/CellAddress.idl>
41#endif
42
43//=============================================================================
44
45module com {  module sun {  module star {  module sheet {
46
47//=============================================================================
48
49/** provides access to the data pilot tables via name and inserting and
50	removing data pilot tables.
51
52	<p>This interface extends the interface
53	<type scope="com::sun::star::container">XNameAccess</type> which provides
54	access to existing data pilot tables in the collection.</p>
55
56	@see com::sun::star::sheet::DataPilotTables
57	@see com::sun::star::sheet::DataPilotTable
58 */
59published interface XDataPilotTables: com::sun::star::container::XNameAccess
60{
61	//-------------------------------------------------------------------------
62
63	/** creates a data pilot descriptor.
64
65		<p>This descriptor can be used with
66		<member>XDataPilotTables::addTable</member>.</p>
67
68		@see com::sun::star::sheet::DataPilotDescriptor
69	 */
70	com::sun::star::sheet::XDataPilotDescriptor createDataPilotDescriptor();
71
72	//-------------------------------------------------------------------------
73
74	/** creates a new data pilot table and adds it to the collection.
75
76		@param aName
77			the name of the data pilot table used in the collection.
78
79		@param aAoutputAddress
80			the top left cell of the location of the data pilot table in
81			the spreadsheet document.
82
83		@param xDescriptor
84			the descriptor containing the settings of the data pilot table.
85
86		@see com::sun::star::sheet::DataPilotDescriptor
87	 */
88	void insertNewByName(
89			[in] string aName,
90			[in] com::sun::star::table::CellAddress aOutputAddress,
91			[in] com::sun::star::sheet::XDataPilotDescriptor xDescriptor );
92
93	//-------------------------------------------------------------------------
94
95	/** deletes a data pilot table from the collection.
96	 */
97	void removeByName( [in] string aName );
98
99};
100
101//=============================================================================
102
103}; }; }; };
104
105#endif
106
107