offapi/com/sun/star/sheet/XDataPilotTable2.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: XDataPilotTable2.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_XDataPilotTable2_idl__
  33 #define __com_sun_star_sheet_XDataPilotTable2_idl__
  34
  35 #ifndef __com_sun_star_uno_XInterface_idl__
  36 #include <com/sun/star/uno/XInterface.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_table_CellAddress_idl__
  40 #include <com/sun/star/table/CellAddress.idl>
  41 #endif
  42
  43 #ifndef __com_sun_star_table_CellRangeAddress_idl__
  44 #include <com/sun/star/table/CellRangeAddress.idl>
  45 #endif
  46
  47 #ifndef __com_sun_star_sheet_XDataPilotTable_idl__
  48 #include <com/sun/star/sheet/XDataPilotTable.idl>
  49 #endif
  50
  51 #ifndef __com_sun_star_sheet_DataPilotOutputRangeType_idl__
  52 #include <com/sun/star/sheet/DataPilotOutputRangeType.idl>
  53 #endif
  54
  55 #ifndef __com_sun_star_sheet_DataPilotFieldFilter_idl__
  56 #include <com/sun/star/sheet/DataPilotFieldFilter.idl>
  57 #endif
  58
  59 #include <com/sun/star/sheet/DataPilotTablePositionData.idl>
  60 #include <com/sun/star/lang/IllegalArgumentException.idl>
  61
  62 module com {  module sun {  module star {  module sheet {
  63
  64 /** additional methods to extend <type scope="com::sun::star::sheet">XDataPilotTable</type>.
  65
  66    <type scope="com::sun::star::sheet">XDataPilotTable2</type> extends the old
  67    <type scope="com::sun::star::sheet">XDataPilotTable</type> interface with
  68    additional methods.
  69
  70    @see com::sun::star::sheet::XDataPilotTable
  71
  72    @since OOo 3.0.0
  73  */
  74 interface XDataPilotTable2: com::sun::star::sheet::XDataPilotTable
  75 {
  76     /** When the address of a cell within the result area is given,
  77         <method>XDataPilotTable2::getDrillDownData</method> returns its drill-down
  78         output table that includes only those rows that contribute to the value of
  79         that cell.
  80
  81         @param aAddr cell address within the result area of a DataPilot table.
  82
  83         @returns drill-down output as 2-dimensional sequence, including the header row.
  84
  85         @see <method>XDataPilotTable2::insertDrillDownSheet</method>
  86      */
  87     sequence< sequence< any > > getDrillDownData( [in] com::sun::star::table::CellAddress aAddr );
  88
  89     /** Given a cell address, it returns the information about that cell.  The
  90         type of information returned depends upon whether the cell is within
  91         the result area or column/row header area.
  92
  93         @param aAddr address of the cell whose information is to be returned.
  94
  95         @returns <type>DataPilotTablePositionData</type> which contains the
  96         position type and the information for that cell position.
  97
  98         @see com::sun::star::sheet::DataPilotTablePositionData
  99         @see com::sun::star::sheet::DataPilotTableHeaderData
 100         @see com::sun::star::sheet::DataPilotTableResultData
 101      */
 102     DataPilotTablePositionData getPositionData( [in] com::sun::star::table::CellAddress aAddr );
 103
 104     /** <p>This method inserts a new sheet to display the drill-down data for a
 105         specified result cell.  A drill-down data for a result cell consists
 106         of a subset of rows from the original data source that contribute to
 107         the value displayed in that cell.</p>
 108
 109         <p>The new sheet is always inserted to the immediate left of the current
 110         sheet where the DataPilot table is.  Note that when the drill-down data
 111         is empty, no new sheet is inserted.</p>
 112
 113         @param aAddr address of a result cell
 114
 115         @returns <void/>
 116      */
 117     void insertDrillDownSheet( [in] com::sun::star::table::CellAddress aAddr );
 118
 119     /** <p>This method returns a different output range of a DataPilot table
 120         per specified output range type.</p>
 121
 122         @returns <type scope="com::sun::star::table">CellRangeAddress</type> depicting
 123         the range specified.  See <type>DataPilotOutputRangeType</type> for a set
 124         of possible output range types.
 125
 126         @see com::sun::star::sheet::DataPilotOutputRangeType
 127      */
 128     com::sun::star::table::CellRangeAddress getOutputRangeByType( [in] long nType )
 129         raises (com::sun::star::lang::IllegalArgumentException);
 130 };
 131
 132 }; }; }; };
 133
 134 #endif
 135