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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: DataPilotField.idl,v $
* $Revision: 1.10 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_sheet_DataPilotField_idl__
#define __com_sun_star_sheet_DataPilotField_idl__
#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif
#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif
#ifndef __com_sun_star_sheet_XDataPilotField_idl__
#include <com/sun/star/sheet/XDataPilotField.idl>
#endif
#ifndef __com_sun_star_sheet_XDataPilotFieldGrouping_idl__
#include <com/sun/star/sheet/XDataPilotFieldGrouping.idl>
#endif
#ifndef __com_sun_star_sheet_DataPilotFieldOrientation_idl__
#include <com/sun/star/sheet/DataPilotFieldOrientation.idl>
#endif
#ifndef __com_sun_star_sheet_GeneralFunction_idl__
#include <com/sun/star/sheet/GeneralFunction.idl>
#endif
#ifndef __com_sun_star_sheet_DataPilotFieldReference_idl__
#include <com/sun/star/sheet/DataPilotFieldReference.idl>
#endif
#ifndef __com_sun_star_sheet_DataPilotFieldLayoutInfo_idl__
#include <com/sun/star/sheet/DataPilotFieldLayoutInfo.idl>
#endif
#ifndef __com_sun_star_sheet_DataPilotFieldAutoShowInfo_idl__
#include <com/sun/star/sheet/DataPilotFieldAutoShowInfo.idl>
#endif
#ifndef __com_sun_star_sheet_DataPilotFieldSortInfo_idl__
#include <com/sun/star/sheet/DataPilotFieldSortInfo.idl>
#endif
#ifndef __com_sun_star_sheet_DataPilotFieldGroupInfo_idl__
#include <com/sun/star/sheet/DataPilotFieldGroupInfo.idl>
#endif
//=============================================================================
module com { module sun { module star { module sheet {
//=============================================================================
/** represents a single field in a data pilot table.
<p>If the data pilot table is based on a spreadsheet cell range, a field
is representred by a column of the range and is named using the topmost
cell of the column.</p>
*/
published service DataPilotField
{
//-------------------------------------------------------------------------
/** provides access to the name of the data pilot field.
*/
interface com::sun::star::container::XNamed;
//-------------------------------------------------------------------------
//!published service PropertySet
/** provides access to the properties.
*/
interface com::sun::star::beans::XPropertySet;
//-------------------------------------------------------------------------
[optional] interface XDataPilotField;
//-------------------------------------------------------------------------
[optional] interface XDataPilotFieldGrouping;
//=========================================================================
/** specifies the orientation of the field.
<p>If the orientation of a field has been changed using this property,
the field will be moved to the last position in the collection of all
fields with the specified orientation.</p>
*/
[property] DataPilotFieldOrientation Orientation;
//-------------------------------------------------------------------------
/** specifies the function used to calculate results for this field.
<p>For column and row fields, this is the function for subtotals
(<const>GeneralFunction::NONE</const> means no subtotals).
For data fields, this is the function shown in the data pilot
table.</p>
*/
[property] GeneralFunction Function;
//-------------------------------------------------------------------------
/** specifies the functions used to calculate subtotals for this field.
<p>This property is supported by column and row fields only.</p>
<p>An empty sequence means no subtotals. The same effect can be
achieved by setting the property <member>Function</member> to the
value <const>GeneralFunction::NONE</const>. If the length of the
sequence is greater then 1, then the sequence MUST NOT contain one of
the values <const>GeneralFunction::NONE</const> or
<const>GeneralFunction::AUTO</const>.</p>
<p>The order of the functions in this sequence is reflected in the
DataPilot table. Multiple entries of the same function are ignored
when setting the property.</p>
*/
[property, optional] sequence<GeneralFunction> Subtotals;
//-------------------------------------------------------------------------
/** specifies the selected page which is used to filter the data pilot.
*/
[property, optional] string SelectedPage;
//-------------------------------------------------------------------------
/** specifies whether to use the selected page to filter the data pilot or
show all.
*/
[property, optional] boolean UseSelectedPage;
//-------------------------------------------------------------------------
/** specifies which hierarchy of the dimension is used.
@see com::sun::star::sheet::DataPilotSourceHierarchies
*/
[property, optional] string UsedHierarchy;
//-------------------------------------------------------------------------
/** specifies whether this field has sorting information.
*/
[property, optional] boolean HasSortInfo;
//-------------------------------------------------------------------------
/** controls how the field's items are sorted.
*/
[property, optional] DataPilotFieldSortInfo SortInfo;
//-------------------------------------------------------------------------
/** specifies whether this field has layout information.
*/
[property, optional] boolean HasLayoutInfo;
//-------------------------------------------------------------------------
/** controls how the field's items are laid out in the result table.
*/
[property, optional] DataPilotFieldLayoutInfo LayoutInfo;
//-------------------------------------------------------------------------
/** specifies whether this field has auto show information.
*/
[property, optional] boolean HasAutoShowInfo;
//-------------------------------------------------------------------------
/** enables the automatic inclusion of only a number of items with
the highest or lowest result values.
*/
[property, optional] DataPilotFieldAutoShowInfo AutoShowInfo;
//-------------------------------------------------------------------------
/** specifies whether this field has a reference.
*/
[property, optional] boolean HasReference;
//-------------------------------------------------------------------------
/** controls how the results are shown in relation to a selected
reference result.
*/
[property, optional] DataPilotFieldReference Reference;
//-------------------------------------------------------------------------
/** specifies whether this field is a group field.
*/
[property, optional] boolean IsGroupField;
//-------------------------------------------------------------------------
/** contains the grouping information of the DataPilot field.
<p>By changing the value of this property it is possible to modify the
grouping settings of this field.</p>
*/
[property, optional] DataPilotFieldGroupInfo GroupInfo;
//-------------------------------------------------------------------------
/** specifies whether to show this field also if it is empty or not.
*/
[property, optional] boolean ShowEmpty;
};
//=============================================================================
}; }; }; };
#endif
|
