offapi/com/sun/star/sheet/DataPilotTablePositionData.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: DataPilotTablePositionData.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_DataPilotTablePositionData_idl__
  33 #define __com_sun_star_sheet_DataPilotTablePositionData_idl__
  34
  35 #include <com/sun/star/sheet/DataPilotFieldFilter.idl>
  36
  37 //=============================================================================
  38
  39 module com {  module sun {  module star {  module sheet {
  40
  41 //=============================================================================
  42
  43 /** This structure contains information on a cell within a DataPilot table.
  44
  45     <p>This structure contains information on a particular cell within a DataPilot
  46     table, and is used to retrieve its metadata.  The <member>PositionType</member>
  47     member specifies in which sub-area of the table the cell is positioned, which
  48     in turn determines the type of metadata contained in the <member>PositionData</member>
  49     member.</p>
  50
  51     @see com::sun::star::sheet::DataPilotTablePositionType
  52     @see com::sun::star::sheet::DataPiotTableResultData
  53     @see com::sun::star::sheet::DataPiotTableHeaderData
  54
  55     @since OOo 3.0.0
  56  */
  57 struct DataPilotTablePositionData
  58 {
  59     //-------------------------------------------------------------------------
  60
  61     /** This parameter specifies which sub-area of a DataPilot table a given
  62         cell is positioned.  See <type>DataPilotTablePositionType</type>
  63         for how to interpret the value of this parameter.
  64
  65         @see com::sun::star::sheet::DataPilotTablePositionType
  66      */
  67     long    PositionType;
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** <p>This member contains a structure of different types depending on the
  72         position type specified in <member>PositionType</member> member.</p>
  73
  74         <p>When the value of <member>PositionType</member> is
  75         <const>DataPilotTablePositionType::RESULT</const>, <member>DataPilotTablePositionData::PositionData</member>
  76         contains an instance of type <type>DataPilotTableResultData</type>,
  77         whereas when the value of <member>DataPilotTablePositionData::PositionType</member>
  78         is either <const>DataPilotTablePositionType::ROW_HEADER</const>
  79         or <const>DataPilotTablePositionType::COLUMN_HEADER</const>, then the
  80         <member>PositionData</member> member contains an instance of type <type>
  81         DataPilotTableHeaderData</type>.</p>
  82
  83         @see com::sun::star::sheet::DataPiotTableResultData
  84         @see com::sun::star::sheet::DataPiotTableHeaderData
  85      */
  86     any     PositionData;
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 #endif
  94