offapi/com/sun/star/sheet/XDataPilotTable2.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 module com {  module sun {  module star {  module sheet {
  21
  22 /** additional methods to extend com::sun::star::sheet::XDataPilotTable.
  23
  24    com::sun::star::sheet::XDataPilotTable2 extends the old
  25    com::sun::star::sheet::XDataPilotTable interface with
  26    additional methods.
  27
  28    @see com::sun::star::sheet::XDataPilotTable
  29
  30    @since OOo 3.0
  31  */
  32 interface XDataPilotTable2: com::sun::star::sheet::XDataPilotTable
  33 {
  34     /** When the address of a cell within the result area is given,
  35         XDataPilotTable2::getDrillDownData() returns its drill-down
  36         output table that includes only those rows that contribute to the value of
  37         that cell.
  38
  39         @param aAddr cell address within the result area of a DataPilot table.
  40
  41         @returns drill-down output as 2-dimensional sequence, including the header row.
  42
  43         @see XDataPilotTable2::insertDrillDownSheet()
  44      */
  45     sequence< sequence< any > > getDrillDownData( [in] com::sun::star::table::CellAddress aAddr );
  46
  47     /** Given a cell address, it returns the information about that cell.  The
  48         type of information returned depends upon whether the cell is within
  49         the result area or column/row header area.
  50
  51         @param aAddr address of the cell whose information is to be returned.
  52
  53         @returns DataPilotTablePositionData which contains the
  54         position type and the information for that cell position.
  55
  56         @see com::sun::star::sheet::DataPilotTablePositionData
  57         @see com::sun::star::sheet::DataPilotTableHeaderData
  58         @see com::sun::star::sheet::DataPilotTableResultData
  59      */
  60     DataPilotTablePositionData getPositionData( [in] com::sun::star::table::CellAddress aAddr );
  61
  62     /** <p>This method inserts a new sheet to display the drill-down data for a
  63         specified result cell.  A drill-down data for a result cell consists
  64         of a subset of rows from the original data source that contribute to
  65         the value displayed in that cell.</p>
  66
  67         <p>The new sheet is always inserted to the immediate left of the current
  68         sheet where the DataPilot table is.  Note that when the drill-down data
  69         is empty, no new sheet is inserted.</p>
  70
  71         @param aAddr address of a result cell
  72      */
  73     void insertDrillDownSheet( [in] com::sun::star::table::CellAddress aAddr );
  74
  75     /** <p>This method returns a different output range of a DataPilot table
  76         per specified output range type.</p>
  77
  78         @returns com::sun::star::table::CellRangeAddress depicting
  79         the range specified.  See DataPilotOutputRangeType for a set
  80         of possible output range types.
  81
  82         @see com::sun::star::sheet::DataPilotOutputRangeType
  83      */
  84     com::sun::star::table::CellRangeAddress getOutputRangeByType( [in] long nType )
  85         raises (com::sun::star::lang::IllegalArgumentException);
  86 };
  87
  88 }; }; }; };
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */