offapi/com/sun/star/sheet/DataPilotTablePositionData.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 #ifndef __com_sun_star_sheet_DataPilotTablePositionData_idl__
  21 #define __com_sun_star_sheet_DataPilotTablePositionData_idl__
  22
  23 #include <com/sun/star/sheet/DataPilotFieldFilter.idl>
  24
  25
  26 module com {  module sun {  module star {  module sheet {
  27
  28
  29 /** This structure contains information on a cell within a DataPilot table.
  30
  31     <p>This structure contains information on a particular cell within a DataPilot
  32     table, and is used to retrieve its metadata.  The #PositionType
  33     member specifies in which sub-area of the table the cell is positioned, which
  34     in turn determines the type of metadata contained in the #PositionData
  35     member.</p>
  36
  37     @see com::sun::star::sheet::DataPilotTablePositionType
  38     @see com::sun::star::sheet::DataPiotTableResultData
  39     @see com::sun::star::sheet::DataPiotTableHeaderData
  40
  41     @since OOo 3.0
  42  */
  43 struct DataPilotTablePositionData
  44 {
  45
  46     /** This parameter specifies which sub-area of a DataPilot table a given
  47         cell is positioned.  See DataPilotTablePositionType
  48         for how to interpret the value of this parameter.
  49
  50         @see com::sun::star::sheet::DataPilotTablePositionType
  51      */
  52     long    PositionType;
  53
  54
  55     /** <p>This member contains a structure of different types depending on the
  56         position type specified in #PositionType member.</p>
  57
  58         <p>When the value of #PositionType is
  59         DataPilotTablePositionType::RESULT, DataPilotTablePositionData::PositionData
  60         contains an instance of type DataPilotTableResultData,
  61         whereas when the value of DataPilotTablePositionData::PositionType
  62         is either DataPilotTablePositionType::ROW_HEADER
  63         or DataPilotTablePositionType::COLUMN_HEADER, then the
  64         #PositionData member contains an instance of type
  65         DataPilotTableHeaderData.</p>
  66
  67         @see com::sun::star::sheet::DataPiotTableResultData
  68         @see com::sun::star::sheet::DataPiotTableHeaderData
  69      */
  70     any     PositionData;
  71 };
  72
  73
  74 }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */