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

   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_DataPilotTableResultData_idl__
  29 #define __com_sun_star_sheet_DataPilotTableResultData_idl__
  30
  31 #include <com/sun/star/sheet/DataPilotFieldFilter.idl>
  32 #include <com/sun/star/sheet/DataResult.idl>
  33
  34 //=============================================================================
  35
  36 module com {  module sun {  module star {  module sheet {
  37
  38 //=============================================================================
  39
  40 /** information about a cell positioned within the result area of a DataPilot table.
  41
  42     <p><type>DataPilotTableResultData</type> contains information about a
  43     particular cell positioned within the result area of a DataPilot table.</p>
  44
  45     @see com::sun::star::sheet::DataPilotTablePositionData
  46     @see com::sun::star::sheet::DataPilotTablePositionType
  47     @see com::sun::star::sheet::DataPilotFieldFilter
  48     @see com::sun::star::sheet::DataResult
  49
  50     @since OOo 3.0.0
  51  */
  52 struct DataPilotTableResultData
  53 {
  54     //------------------------------------------------------------------------
  55
  56     /** This is a set of filter criteria that can be used to re-create those
  57         data rows that contribute to the value shown in the cell.
  58
  59         @see com::sun::star::sheet::DataPilotFieldFilter
  60      */
  61     sequence< DataPilotFieldFilter >    FieldFilters;
  62
  63     //------------------------------------------------------------------------
  64
  65     /** This is a 0-based index that specifies which data field the data displayed
  66         in the cell is for; the value of 0 means the cell is for the first data
  67         field, 1 for the second, and so on.
  68      */
  69     long                                DataFieldIndex;
  70
  71     //------------------------------------------------------------------------
  72
  73     /** more information about the result contained in the
  74         <type>DataResult</type> type.
  75
  76         @see com::sun::star::sheet::DataResult
  77      */
  78     DataResult                          Result;
  79 };
  80
  81 //=============================================================================
  82
  83 }; }; }; };
  84
  85 #endif
  86