1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_sheet_DataPilotTablePositionData_idl__
29#define __com_sun_star_sheet_DataPilotTablePositionData_idl__
30
31#include <com/sun/star/sheet/DataPilotFieldFilter.idl>
32
33//=============================================================================
34
35module com {  module sun {  module star {  module sheet {
36
37//=============================================================================
38
39/** This structure contains information on a cell within a DataPilot table.
40
41    <p>This structure contains information on a particular cell within a DataPilot
42    table, and is used to retrieve its metadata.  The <member>PositionType</member>
43    member specifies in which sub-area of the table the cell is positioned, which
44    in turn determines the type of metadata contained in the <member>PositionData</member>
45    member.</p>
46
47    @see com::sun::star::sheet::DataPilotTablePositionType
48    @see com::sun::star::sheet::DataPiotTableResultData
49    @see com::sun::star::sheet::DataPiotTableHeaderData
50
51    @since OOo 3.0
52 */
53struct DataPilotTablePositionData
54{
55	//-------------------------------------------------------------------------
56
57    /** This parameter specifies which sub-area of a DataPilot table a given
58        cell is positioned.  See <type>DataPilotTablePositionType</type>
59        for how to interpret the value of this parameter.
60
61        @see com::sun::star::sheet::DataPilotTablePositionType
62     */
63    long    PositionType;
64
65	//-------------------------------------------------------------------------
66
67    /** <p>This member contains a structure of different types depending on the
68        position type specified in <member>PositionType</member> member.</p>
69
70        <p>When the value of <member>PositionType</member> is
71        <const>DataPilotTablePositionType::RESULT</const>, <member>DataPilotTablePositionData::PositionData</member>
72        contains an instance of type <type>DataPilotTableResultData</type>,
73        whereas when the value of <member>DataPilotTablePositionData::PositionType</member>
74        is either <const>DataPilotTablePositionType::ROW_HEADER</const>
75        or <const>DataPilotTablePositionType::COLUMN_HEADER</const>, then the
76        <member>PositionData</member> member contains an instance of type <type>
77        DataPilotTableHeaderData</type>.</p>
78
79        @see com::sun::star::sheet::DataPiotTableResultData
80        @see com::sun::star::sheet::DataPiotTableHeaderData
81     */
82    any     PositionData;
83};
84
85//=============================================================================
86
87}; }; }; };
88
89#endif
90
91