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_DataPilotField_idl__
25#define __com_sun_star_sheet_DataPilotField_idl__
26
27#ifndef __com_sun_star_container_XNamed_idl__
28#include <com/sun/star/container/XNamed.idl>
29#endif
30
31#ifndef __com_sun_star_beans_XPropertySet_idl__
32#include <com/sun/star/beans/XPropertySet.idl>
33#endif
34
35#ifndef __com_sun_star_sheet_XDataPilotField_idl__
36#include <com/sun/star/sheet/XDataPilotField.idl>
37#endif
38
39#ifndef __com_sun_star_sheet_XDataPilotFieldGrouping_idl__
40#include <com/sun/star/sheet/XDataPilotFieldGrouping.idl>
41#endif
42
43#ifndef __com_sun_star_sheet_DataPilotFieldOrientation_idl__
44#include <com/sun/star/sheet/DataPilotFieldOrientation.idl>
45#endif
46
47#ifndef __com_sun_star_sheet_GeneralFunction_idl__
48#include <com/sun/star/sheet/GeneralFunction.idl>
49#endif
50
51#ifndef __com_sun_star_sheet_DataPilotFieldReference_idl__
52#include <com/sun/star/sheet/DataPilotFieldReference.idl>
53#endif
54
55#ifndef __com_sun_star_sheet_DataPilotFieldLayoutInfo_idl__
56#include <com/sun/star/sheet/DataPilotFieldLayoutInfo.idl>
57#endif
58
59#ifndef __com_sun_star_sheet_DataPilotFieldAutoShowInfo_idl__
60#include <com/sun/star/sheet/DataPilotFieldAutoShowInfo.idl>
61#endif
62
63#ifndef __com_sun_star_sheet_DataPilotFieldSortInfo_idl__
64#include <com/sun/star/sheet/DataPilotFieldSortInfo.idl>
65#endif
66
67#ifndef __com_sun_star_sheet_DataPilotFieldGroupInfo_idl__
68#include <com/sun/star/sheet/DataPilotFieldGroupInfo.idl>
69#endif
70
71//=============================================================================
72
73module com {  module sun {  module star {  module sheet {
74
75//=============================================================================
76
77/** represents a single field in a data pilot table.
78
79    <p>If the data pilot table is based on a spreadsheet cell range, a field
80    is representred by a column of the range and is named using the topmost
81    cell of the column.</p>
82 */
83published service DataPilotField
84{
85    //-------------------------------------------------------------------------
86
87    /** provides access to the name of the data pilot field.
88     */
89    interface com::sun::star::container::XNamed;
90
91    //-------------------------------------------------------------------------
92
93//!published service PropertySet
94    /** provides access to the properties.
95     */
96    interface com::sun::star::beans::XPropertySet;
97
98    //-------------------------------------------------------------------------
99
100    [optional] interface XDataPilotField;
101
102    //-------------------------------------------------------------------------
103
104    [optional] interface XDataPilotFieldGrouping;
105
106    //=========================================================================
107
108    /** specifies the orientation of the field.
109
110        <p>If the orientation of a field has been changed using this property,
111        the field will be moved to the last position in the collection of all
112        fields with the specified orientation.</p>
113     */
114    [property] DataPilotFieldOrientation Orientation;
115
116    //-------------------------------------------------------------------------
117
118    /** specifies the function used to calculate results for this field.
119
120        <p>For column and row fields, this is the function for subtotals
121        (<const>GeneralFunction::NONE</const> means no subtotals).
122        For data fields, this is the function shown in the data pilot
123        table.</p>
124     */
125    [property] GeneralFunction Function;
126
127    //-------------------------------------------------------------------------
128
129    /** specifies the functions used to calculate subtotals for this field.
130
131        <p>This property is supported by column and row fields only.</p>
132
133        <p>An empty sequence means no subtotals. The same effect can be
134        achieved by setting the property <member>Function</member> to the
135        value <const>GeneralFunction::NONE</const>. If the length of the
136        sequence is greater then 1, then the sequence MUST NOT contain one of
137        the values <const>GeneralFunction::NONE</const> or
138        <const>GeneralFunction::AUTO</const>.</p>
139
140        <p>The order of the functions in this sequence is reflected in the
141        DataPilot table. Multiple entries of the same function are ignored
142        when setting the property.</p>
143     */
144    [property, optional] sequence<GeneralFunction> Subtotals;
145
146    //-------------------------------------------------------------------------
147
148    /** specifies the selected page which is used to filter the data pilot.
149     */
150    [property, optional] string SelectedPage;
151
152    //-------------------------------------------------------------------------
153
154    /** specifies whether to use the selected page to filter the data pilot or
155        show all.
156     */
157    [property, optional] boolean UseSelectedPage;
158
159    //-------------------------------------------------------------------------
160
161    /** specifies which hierarchy of the dimension is used.
162
163    @see com::sun::star::sheet::DataPilotSourceHierarchies
164     */
165    [property, optional] string UsedHierarchy;
166
167    //-------------------------------------------------------------------------
168
169    /** specifies whether this field has sorting information.
170     */
171    [property, optional] boolean HasSortInfo;
172
173    //-------------------------------------------------------------------------
174
175    /** controls how the field's items are sorted.
176     */
177    [property, optional] DataPilotFieldSortInfo SortInfo;
178
179    //-------------------------------------------------------------------------
180
181    /** specifies whether this field has layout information.
182     */
183    [property, optional] boolean HasLayoutInfo;
184
185    //-------------------------------------------------------------------------
186
187    /** controls how the field's items are laid out in the result table.
188     */
189    [property, optional] DataPilotFieldLayoutInfo LayoutInfo;
190
191    //-------------------------------------------------------------------------
192
193    /** specifies whether this field has auto show information.
194     */
195    [property, optional] boolean HasAutoShowInfo;
196
197    //-------------------------------------------------------------------------
198
199    /** enables the automatic inclusion of only a number of items with
200        the highest or lowest result values.
201     */
202    [property, optional] DataPilotFieldAutoShowInfo AutoShowInfo;
203
204    //-------------------------------------------------------------------------
205
206    /** specifies whether this field has a reference.
207     */
208    [property, optional] boolean HasReference;
209
210    //-------------------------------------------------------------------------
211
212    /** controls how the results are shown in relation to a selected
213        reference result.
214     */
215    [property, optional] DataPilotFieldReference Reference;
216
217    //-------------------------------------------------------------------------
218
219    /** specifies whether this field is a group field.
220     */
221    [property, optional] boolean IsGroupField;
222
223    //-------------------------------------------------------------------------
224
225    /** contains the grouping information of the DataPilot field.
226
227        <p>By changing the value of this property it is possible to modify the
228        grouping settings of this field.</p>
229     */
230    [property, optional] DataPilotFieldGroupInfo GroupInfo;
231
232    //-------------------------------------------------------------------------
233
234    /** specifies whether to show this field also if it is empty or not.
235     */
236    [property, optional] boolean ShowEmpty;
237};
238
239//=============================================================================
240
241}; }; }; };
242
243#endif
244
245