summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/DataPilotDescriptor.idl
blob: 9a370cef8e3c8024463323354b7d6e20e73838e1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_sheet_DataPilotTableDescriptor_idl__
#define __com_sun_star_sheet_DataPilotTableDescriptor_idl__

#include <com/sun/star/sheet/XDataPilotDescriptor.idl>
#include <com/sun/star/sheet/XDataPilotDataLayoutFieldSupplier.idl>
#include <com/sun/star/beans/XPropertySet.idl>
#include <com/sun/star/beans/PropertyValue.idl>

//=============================================================================

module com { module sun { module star { module sheet {

//=============================================================================

/** represents the description of the layout of a data pilot table.

    @see com::sun::star::sheet::DataPilotTable
*/
published service DataPilotDescriptor
{
    //-------------------------------------------------------------------------

    /** provides access to the layout settings of the data pilot table.
     */
    interface XDataPilotDescriptor;

    //-------------------------------------------------------------------------

    /** provides access to the layout settings of the data pilot table.
     */
    [optional] interface com::sun::star::beans::XPropertySet;

    //-------------------------------------------------------------------------

    /** Provides access to the <type>DataPilotField</type> used to layout
        multiple data fields.
     */
    [optional] interface XDataPilotDataLayoutFieldSupplier;

    //=========================================================================

    /** specifies parameters to create the data pilot table from a database.

    @see DatabaseImportDescriptor
    @since OOo 3.3

     */
    [optional, property] sequence< com::sun::star::beans::PropertyValue > ImportDescriptor;

    //-------------------------------------------------------------------------

    /** specifies the name of a <type>DataPilotSource</type> implementation
        for the data pilot table.

    @since OOo 3.3

     */
    [optional, property] string SourceServiceName;

    //-------------------------------------------------------------------------

    /** specifies arguments that are passed to the implementation named by
        <member>SourceServiceName</member>.

    @since OOo 3.3

     */
    [optional, property] sequence< com::sun::star::beans::PropertyValue > ServiceArguments;

    //-------------------------------------------------------------------------

    /** specifies if empty rows in the source data are ignored.
     */
    [optional, property] boolean IgnoreEmptyRows;

    //-------------------------------------------------------------------------

    /** specifies if empty category cells in the source data should be treated
        as repetition of the content from the previous row.
     */
    [optional, property] boolean RepeatIfEmpty;

    //-------------------------------------------------------------------------

    /** specifies if columns for grand total results are created.
     */
    [optional, property] boolean ColumnGrand;

    //-------------------------------------------------------------------------

    /** specifies if rows for grand total results are created.
     */
    [optional, property] boolean RowGrand;

    //-------------------------------------------------------------------------

    /** specifies whether the filter button is shown.
     */
    [optional, property] boolean ShowFilterButton;

    //-------------------------------------------------------------------------

    /** specifies whether to drill down to details or go into edit mode.
     */
    [optional, property] boolean DrillDownOnDoubleClick;

    //-------------------------------------------------------------------------

    /** specifies a label for grand total results.

    @since OOo 3.4
     */
    [optional, property] string GrandTotalName;

    //-------------------------------------------------------------------------
};

//=============================================================================

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */