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_DataPilotTableDescriptor_idl__
25#define __com_sun_star_sheet_DataPilotTableDescriptor_idl__
26
27#ifndef __com_sun_star_sheet_XDataPilotDescriptor_idl__
28#include <com/sun/star/sheet/XDataPilotDescriptor.idl>
29#endif
30
31#ifndef __com_sun_star_sheet_XDataPilotDataLayoutFieldSupplier_idl__
32#include <com/sun/star/sheet/XDataPilotDataLayoutFieldSupplier.idl>
33#endif
34
35#ifndef __com_sun_star_beans_XPropertySet_idl__
36#include <com/sun/star/beans/XPropertySet.idl>
37#endif
38
39#ifndef __com_sun_star_beans_PropertyValue_idl__
40#include <com/sun/star/beans/PropertyValue.idl>
41#endif
42
43//=============================================================================
44
45module com { module sun { module star { module sheet {
46
47//=============================================================================
48
49/** represents the description of the layout of a data pilot table.
50
51	@see com::sun::star::sheet::DataPilotTable
52*/
53published service DataPilotDescriptor
54{
55	//-------------------------------------------------------------------------
56
57	/** provides access to the layout settings of the data pilot table.
58	 */
59    interface XDataPilotDescriptor;
60
61	//-------------------------------------------------------------------------
62
63	/** provides access to the layout settings of the data pilot table.
64	 */
65	[optional] interface com::sun::star::beans::XPropertySet;
66
67    //-------------------------------------------------------------------------
68
69    /** Provides access to the <type>DataPilotField</type> used to layout
70        multiple data fields.
71     */
72    [optional] interface XDataPilotDataLayoutFieldSupplier;
73
74    //=========================================================================
75
76    /** specifies parameters to create the data pilot table from a database.
77
78    @see DatabaseImportDescriptor
79    @since OOo 3.3
80
81     */
82    [optional, property] sequence< com::sun::star::beans::PropertyValue > ImportDescriptor;
83
84    //-------------------------------------------------------------------------
85
86    /** specifies the name of a <type>DataPilotSource</type> implementation
87        for the data pilot table.
88
89    @since OOo 3.3
90
91     */
92    [optional, property] string SourceServiceName;
93
94    //-------------------------------------------------------------------------
95
96    /** specifies arguments that are passed to the implementation named by
97        <member>SourceServiceName</member>.
98
99    @since OOo 3.3
100
101     */
102    [optional, property] sequence< com::sun::star::beans::PropertyValue > ServiceArguments;
103
104    //-------------------------------------------------------------------------
105
106    /** specifies if empty rows in the source data are ignored.
107	 */
108	[optional, property] boolean IgnoreEmptyRows;
109
110	//-------------------------------------------------------------------------
111
112    /** specifies if empty category cells in the source data should be treated
113        as repetition of the content from the previous row.
114	 */
115	[optional, property] boolean RepeatIfEmpty;
116
117	//-------------------------------------------------------------------------
118
119    /** specifies if columns for grand total results are created.
120	 */
121	[optional, property] boolean ColumnGrand;
122
123	//-------------------------------------------------------------------------
124
125    /** specifies if rows for grand total results are created.
126	 */
127	[optional, property] boolean RowGrand;
128
129	//-------------------------------------------------------------------------
130
131	/** specifies whether the filter button is shown.
132	 */
133	[optional, property] boolean ShowFilterButton;
134
135	//-------------------------------------------------------------------------
136
137	/** specifies whether to drill down to details or go into edit mode.
138	 */
139	[optional, property] boolean DrillDownOnDoubleClick;
140
141	//-------------------------------------------------------------------------
142
143    /** specifies a label for grand total results.
144
145    @since OOo 3.4
146     */
147    [optional, property] string GrandTotalName;
148
149    //-------------------------------------------------------------------------
150};
151
152//=============================================================================
153
154}; }; }; };
155
156#endif
157