xref: /AOO41X/main/offapi/com/sun/star/sheet/DataPilotTableResultData.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir/*************************************************************************
2*cdf0e10cSrcweir *
3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir *
5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir *
7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir *
9*cdf0e10cSrcweir * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir *
11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir *
15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir *
21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir *
26*cdf0e10cSrcweir ************************************************************************/
27*cdf0e10cSrcweir
28*cdf0e10cSrcweir#ifndef __com_sun_star_sheet_DataPilotTableResultData_idl__
29*cdf0e10cSrcweir#define __com_sun_star_sheet_DataPilotTableResultData_idl__
30*cdf0e10cSrcweir
31*cdf0e10cSrcweir#include <com/sun/star/sheet/DataPilotFieldFilter.idl>
32*cdf0e10cSrcweir#include <com/sun/star/sheet/DataResult.idl>
33*cdf0e10cSrcweir
34*cdf0e10cSrcweir//=============================================================================
35*cdf0e10cSrcweir
36*cdf0e10cSrcweirmodule com {  module sun {  module star {  module sheet {
37*cdf0e10cSrcweir
38*cdf0e10cSrcweir//=============================================================================
39*cdf0e10cSrcweir
40*cdf0e10cSrcweir/** information about a cell positioned within the result area of a DataPilot table.
41*cdf0e10cSrcweir
42*cdf0e10cSrcweir    <p><type>DataPilotTableResultData</type> contains information about a
43*cdf0e10cSrcweir    particular cell positioned within the result area of a DataPilot table.</p>
44*cdf0e10cSrcweir
45*cdf0e10cSrcweir    @see com::sun::star::sheet::DataPilotTablePositionData
46*cdf0e10cSrcweir    @see com::sun::star::sheet::DataPilotTablePositionType
47*cdf0e10cSrcweir    @see com::sun::star::sheet::DataPilotFieldFilter
48*cdf0e10cSrcweir    @see com::sun::star::sheet::DataResult
49*cdf0e10cSrcweir
50*cdf0e10cSrcweir    @since OOo 3.0
51*cdf0e10cSrcweir */
52*cdf0e10cSrcweirstruct DataPilotTableResultData
53*cdf0e10cSrcweir{
54*cdf0e10cSrcweir    //------------------------------------------------------------------------
55*cdf0e10cSrcweir
56*cdf0e10cSrcweir    /** This is a set of filter criteria that can be used to re-create those
57*cdf0e10cSrcweir        data rows that contribute to the value shown in the cell.
58*cdf0e10cSrcweir
59*cdf0e10cSrcweir        @see com::sun::star::sheet::DataPilotFieldFilter
60*cdf0e10cSrcweir     */
61*cdf0e10cSrcweir    sequence< DataPilotFieldFilter >    FieldFilters;
62*cdf0e10cSrcweir
63*cdf0e10cSrcweir    //------------------------------------------------------------------------
64*cdf0e10cSrcweir
65*cdf0e10cSrcweir    /** This is a 0-based index that specifies which data field the data displayed
66*cdf0e10cSrcweir        in the cell is for; the value of 0 means the cell is for the first data
67*cdf0e10cSrcweir        field, 1 for the second, and so on.
68*cdf0e10cSrcweir     */
69*cdf0e10cSrcweir    long                                DataFieldIndex;
70*cdf0e10cSrcweir
71*cdf0e10cSrcweir    //------------------------------------------------------------------------
72*cdf0e10cSrcweir
73*cdf0e10cSrcweir    /** more information about the result contained in the
74*cdf0e10cSrcweir        <type>DataResult</type> type.
75*cdf0e10cSrcweir
76*cdf0e10cSrcweir        @see com::sun::star::sheet::DataResult
77*cdf0e10cSrcweir     */
78*cdf0e10cSrcweir    DataResult                          Result;
79*cdf0e10cSrcweir};
80*cdf0e10cSrcweir
81*cdf0e10cSrcweir//=============================================================================
82*cdf0e10cSrcweir
83*cdf0e10cSrcweir}; }; }; };
84*cdf0e10cSrcweir
85*cdf0e10cSrcweir#endif
86*cdf0e10cSrcweir
87