offapi/com/sun/star/sheet/XDataPilotResults.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_XDataPilotResults_idl__
  21 #define __com_sun_star_sheet_XDataPilotResults_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/sheet/DataResult.idl>
  25 #include <com/sun/star/sheet/DataPilotFieldFilter.idl>
  26
  27
  28 module com {  module sun {  module star {  module sheet {
  29
  30
  31 /** provides access to a table of results of a data pilot source.
  32
  33     <p>These results are used to fill the data area of a data pilot table.</p>
  34
  35     @see com::sun::star::sheet::DataPilotSource
  36     @see com::sun::star::sheet::XDataPilotMemberResults
  37  */
  38 interface XDataPilotResults: com::sun::star::uno::XInterface
  39 {
  40
  41     /** returns the result array.
  42
  43         <p>The outer sequence contains the value rows. The inner sequences
  44         contain the values for one row.</p>
  45      */
  46     sequence< sequence< DataResult > > getResults();
  47
  48     sequence<double> getFilteredResults(
  49         [in] sequence<com::sun::star::sheet::DataPilotFieldFilter> aFilters );
  50 };
  51
  52
  53 }; }; }; };
  54
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */