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_DataPilotSource_idl__
29#define __com_sun_star_sheet_DataPilotSource_idl__
30
31#ifndef __com_sun_star_sheet_XDimensionsSupplier_idl__
32#include <com/sun/star/sheet/XDimensionsSupplier.idl>
33#endif
34
35#ifndef __com_sun_star_sheet_XDataPilotResults_idl__
36#include <com/sun/star/sheet/XDataPilotResults.idl>
37#endif
38
39#ifndef __com_sun_star_util_XRefreshable_idl__
40#include <com/sun/star/util/XRefreshable.idl>
41#endif
42
43#ifndef __com_sun_star_beans_XPropertySet_idl__
44#include <com/sun/star/beans/XPropertySet.idl>
45#endif
46
47//=============================================================================
48
49module com {  module sun {  module star {  module sheet {
50
51//=============================================================================
52
53/** represents a data pilot source.
54
55	<p>A component that implements this service can be used as data source
56	for a data pilot table in a spreadsheet document.</p>
57 */
58published service DataPilotSource
59{
60	//-------------------------------------------------------------------------
61
62	/** provides access to the collection of the dimensions of the data
63		pilot source.
64	 */
65	interface com::sun::star::sheet::XDimensionsSupplier;
66
67	//-------------------------------------------------------------------------
68
69	/** gives access to the results of the data pilot table.
70	 */
71	interface com::sun::star::sheet::XDataPilotResults;
72
73	//-------------------------------------------------------------------------
74
75	/** provides methods to refresh the data pilot table, that means to
76		read the data again from the data pilot source.
77	 */
78	interface com::sun::star::util::XRefreshable;
79
80	//-------------------------------------------------------------------------
81
82//!published service PropertySet
83	/** provides access to the properties.
84	 */
85	interface com::sun::star::beans::XPropertySet;
86
87	//=========================================================================
88
89	/** specifies if grand totals for the columns are inserted.
90	 */
91	[property] boolean ColumnGrand;
92
93	//-------------------------------------------------------------------------
94
95	/** specifies if grand totals for the rows are inserted.
96	 */
97	[property] boolean RowGrand;
98
99    //-------------------------------------------------------------------------
100
101    /** specifies the number of row fields.
102
103        @since OOo 3.0
104     */
105    [readonly, property, optional] long RowFieldCount;
106
107    //-------------------------------------------------------------------------
108
109    /** specifies the number of column fields.
110
111        @since OOo 3.0
112     */
113    [readonly, property, optional] long ColumnFieldCount;
114
115    //-------------------------------------------------------------------------
116
117    /** specifies the number of data fields.
118
119        @since OOo 3.0
120     */
121    [readonly, property, optional] long DataFieldCount;
122};
123
124//=============================================================================
125
126}; }; }; };
127
128#endif
129
130