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_DataPilotTablePositionData_idl__
25#define __com_sun_star_sheet_DataPilotTablePositionData_idl__
26
27#include <com/sun/star/sheet/DataPilotFieldFilter.idl>
28
29//=============================================================================
30
31module com {  module sun {  module star {  module sheet {
32
33//=============================================================================
34
35/** This structure contains information on a cell within a DataPilot table.
36
37    <p>This structure contains information on a particular cell within a DataPilot
38    table, and is used to retrieve its metadata.  The <member>PositionType</member>
39    member specifies in which sub-area of the table the cell is positioned, which
40    in turn determines the type of metadata contained in the <member>PositionData</member>
41    member.</p>
42
43    @see com::sun::star::sheet::DataPilotTablePositionType
44    @see com::sun::star::sheet::DataPiotTableResultData
45    @see com::sun::star::sheet::DataPiotTableHeaderData
46
47    @since OpenOffice 3.0
48 */
49struct DataPilotTablePositionData
50{
51	//-------------------------------------------------------------------------
52
53    /** This parameter specifies which sub-area of a DataPilot table a given
54        cell is positioned.  See <type>DataPilotTablePositionType</type>
55        for how to interpret the value of this parameter.
56
57        @see com::sun::star::sheet::DataPilotTablePositionType
58     */
59    long    PositionType;
60
61	//-------------------------------------------------------------------------
62
63    /** <p>This member contains a structure of different types depending on the
64        position type specified in <member>PositionType</member> member.</p>
65
66        <p>When the value of <member>PositionType</member> is
67        <const>DataPilotTablePositionType::RESULT</const>, <member>DataPilotTablePositionData::PositionData</member>
68        contains an instance of type <type>DataPilotTableResultData</type>,
69        whereas when the value of <member>DataPilotTablePositionData::PositionType</member>
70        is either <const>DataPilotTablePositionType::ROW_HEADER</const>
71        or <const>DataPilotTablePositionType::COLUMN_HEADER</const>, then the
72        <member>PositionData</member> member contains an instance of type <type>
73        DataPilotTableHeaderData</type>.</p>
74
75        @see com::sun::star::sheet::DataPiotTableResultData
76        @see com::sun::star::sheet::DataPiotTableHeaderData
77     */
78    any     PositionData;
79};
80
81//=============================================================================
82
83}; }; }; };
84
85#endif
86
87