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