offapi/com/sun/star/sheet/XConsolidatable.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: XConsolidatable.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sheet_XConsolidatable_idl__
  32 #define __com_sun_star_sheet_XConsolidatable_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_sheet_XConsolidationDescriptor_idl__
  39 #include <com/sun/star/sheet/XConsolidationDescriptor.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** provides methods to consolidate ranges in a spreadsheet document.
  49
  50     <p>Consolidation combines the cells of multiple cell ranges, using a
  51     specific function.</p>
  52
  53     @deprecated
  54  */
  55 published interface XConsolidatable: com::sun::star::uno::XInterface
  56 {
  57     //-------------------------------------------------------------------------
  58
  59     /** creates a consolidation descriptor.
  60
  61         @param bEmpty
  62             <TRUE/> leaves the descriptor empty, <FALSE/> fills it with
  63             the settings from the last consolidation action.
  64
  65         @see com::sun::star::sheet::ConsolidationDescriptor
  66      */
  67     com::sun::star::sheet::XConsolidationDescriptor createConsolidationDescriptor(
  68             [in] boolean bEmpty );
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** consolidates data from several cell ranges, using the settings
  73         in the passed descriptor.
  74
  75         @param xDescriptor
  76             the descriptor used to perform the consolidation.
  77
  78         @see com::sun::star::sheet::ConsolidationDescriptor
  79      */
  80     void consolidate(
  81             [in] com::sun::star::sheet::XConsolidationDescriptor xDescriptor );
  82
  83 };
  84
  85 //=============================================================================
  86
  87 }; }; }; };
  88
  89 #endif
  90