offapi/com/sun/star/sheet/DataPilotTableResultData.idl

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