/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_DataPilotTableResultData_idl__
#define __com_sun_star_sheet_DataPilotTableResultData_idl__

#include <com/sun/star/sheet/DataPilotFieldFilter.idl>
#include <com/sun/star/sheet/DataResult.idl>

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** information about a cell positioned within the result area of a DataPilot table.

    <p><type>DataPilotTableResultData</type> contains information about a 
    particular cell positioned within the result area of a DataPilot table.</p>

    @see com::sun::star::sheet::DataPilotTablePositionData
    @see com::sun::star::sheet::DataPilotTablePositionType
    @see com::sun::star::sheet::DataPilotFieldFilter
    @see com::sun::star::sheet::DataResult

    @since OOo 3.0
 */
struct DataPilotTableResultData
{
    //------------------------------------------------------------------------

    /** This is a set of filter criteria that can be used to re-create those
        data rows that contribute to the value shown in the cell.

        @see com::sun::star::sheet::DataPilotFieldFilter
     */
    sequence< DataPilotFieldFilter >    FieldFilters;

    //------------------------------------------------------------------------

    /** This is a 0-based index that specifies which data field the data displayed
        in the cell is for; the value of 0 means the cell is for the first data
        field, 1 for the second, and so on.
     */
    long                                DataFieldIndex;

    //------------------------------------------------------------------------

    /** more information about the result contained in the 
        <type>DataResult</type> type.

        @see com::sun::star::sheet::DataResult
     */
    DataResult                          Result;
};

//=============================================================================

}; }; }; };

#endif

