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_XDataPilotDataLayoutFieldSupplier_idl__
25#define __com_sun_star_sheet_XDataPilotDataLayoutFieldSupplier_idl__
26
27#ifndef __com_sun_star_sheet_XDataPilotField_idl__
28#include <com/sun/star/sheet/XDataPilotField.idl>
29#endif
30
31//=============================================================================
32
33module com {  module sun {  module star {  module sheet {
34
35//=============================================================================
36
37/** Provides access to the <type>DataPilotField</type> used to layout
38    multiple data fields.
39
40    <p>This data field can be inserted into the rows dimension or columns
41    dimension by changing its <member scope="DataPilotField">Orientation</member>
42    property. This interface can be used to access the data layout field
43    before multiple data fields are inserted into the DataPilot table. It
44    remains invisible as long as the DataPilot table contains at most one data
45    field.</p>
46
47	@see com::sun::star::sheet::DataPilotDescriptor
48	@see com::sun::star::sheet::DataPilotTable
49 */
50published interface XDataPilotDataLayoutFieldSupplier
51{
52    //-------------------------------------------------------------------------
53
54    /** Returns the <type>DataPilotField</type> used to layout multiple data
55        fields.
56
57        <p>If the field does not exist yet, it will be created. It is possible
58        to insert this field into the rows or columns dimension by changing
59        its <member scope="DataPilotField">Orientation</member> property.</p>
60     */
61    XDataPilotField getDataLayoutField();
62
63};
64
65//=============================================================================
66
67}; }; }; };
68
69#endif
70
71