1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 *   Licensed to the Apache Software Foundation (ASF) under one or more
12 *   contributor license agreements. See the NOTICE file distributed
13 *   with this work for additional information regarding copyright
14 *   ownership. The ASF licenses this file to you under the Apache
15 *   License, Version 2.0 (the "License"); you may not use this file
16 *   except in compliance with the License. You may obtain a copy of
17 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef __com_sun_star_sheet_DataPilotDescriptor_idl__
21#define __com_sun_star_sheet_DataPilotDescriptor_idl__
22
23#include <com/sun/star/sheet/XDataPilotDescriptor.idl>
24#include <com/sun/star/sheet/XDataPilotDataLayoutFieldSupplier.idl>
25#include <com/sun/star/beans/XPropertySet.idl>
26#include <com/sun/star/beans/PropertyValue.idl>
27
28
29module com { module sun { module star { module sheet {
30
31
32/** represents the description of the layout of a data pilot table.
33
34    @see com::sun::star::sheet::DataPilotTable
35*/
36published service DataPilotDescriptor
37{
38
39    /** provides access to the layout settings of the data pilot table.
40     */
41    interface XDataPilotDescriptor;
42
43
44    /** provides access to the layout settings of the data pilot table.
45     */
46    [optional] interface com::sun::star::beans::XPropertySet;
47
48
49    /** Provides access to the DataPilotField used to layout
50        multiple data fields.
51     */
52    [optional] interface XDataPilotDataLayoutFieldSupplier;
53
54
55    /** specifies parameters to create the data pilot table from a database.
56
57    @see DatabaseImportDescriptor
58    @since OOo 3.3
59
60     */
61    [optional, property] sequence< com::sun::star::beans::PropertyValue > ImportDescriptor;
62
63
64    /** specifies the name of a DataPilotSource implementation
65        for the data pilot table.
66
67    @since OOo 3.3
68
69     */
70    [optional, property] string SourceServiceName;
71
72
73    /** specifies arguments that are passed to the implementation named by
74        #SourceServiceName.
75
76    @since OOo 3.3
77
78     */
79    [optional, property] sequence< com::sun::star::beans::PropertyValue > ServiceArguments;
80
81
82    /** specifies if empty rows in the source data are ignored.
83     */
84    [optional, property] boolean IgnoreEmptyRows;
85
86
87    /** specifies if empty category cells in the source data should be treated
88        as repetition of the content from the previous row.
89     */
90    [optional, property] boolean RepeatIfEmpty;
91
92
93    /** specifies if columns for grand total results are created.
94     */
95    [optional, property] boolean ColumnGrand;
96
97
98    /** specifies if rows for grand total results are created.
99     */
100    [optional, property] boolean RowGrand;
101
102
103    /** specifies whether the filter button is shown.
104     */
105    [optional, property] boolean ShowFilterButton;
106
107
108    /** specifies whether to drill down to details or go into edit mode.
109     */
110    [optional, property] boolean DrillDownOnDoubleClick;
111
112
113    /** specifies a label for grand total results.
114
115    @since OOo 3.4
116     */
117    [optional, property] string GrandTotalName;
118
119};
120
121
122}; }; }; };
123
124#endif
125
126/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
127