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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** information about a cell positioned within the result area of a DataPilot table.
  25
  26     <p>DataPilotTableResultData contains information about a
  27     particular cell positioned within the result area of a DataPilot table.</p>
  28
  29     @see com::sun::star::sheet::DataPilotTablePositionData
  30     @see com::sun::star::sheet::DataPilotTablePositionType
  31     @see com::sun::star::sheet::DataPilotFieldFilter
  32     @see com::sun::star::sheet::DataResult
  33
  34     @since OOo 3.0
  35  */
  36 struct DataPilotTableResultData
  37 {
  38
  39     /** This is a set of filter criteria that can be used to re-create those
  40         data rows that contribute to the value shown in the cell.
  41
  42         @see com::sun::star::sheet::DataPilotFieldFilter
  43      */
  44     sequence< DataPilotFieldFilter >    FieldFilters;
  45
  46
  47     /** This is a 0-based index that specifies which data field the data displayed
  48         in the cell is for; the value of 0 means the cell is for the first data
  49         field, 1 for the second, and so on.
  50      */
  51     long                                DataFieldIndex;
  52
  53
  54     /** more information about the result contained in the
  55         DataResult type.
  56
  57         @see com::sun::star::sheet::DataResult
  58      */
  59     DataResult                          Result;
  60 };
  61
  62
  63 }; }; }; };
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */