offapi/com/sun/star/sheet/XConsolidatable.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_XConsolidatable_idl__
  21 #define __com_sun_star_sheet_XConsolidatable_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/sheet/XConsolidationDescriptor.idl>
  25
  26
  27 module com {  module sun {  module star {  module sheet {
  28
  29
  30 /** provides methods to consolidate ranges in a spreadsheet document.
  31
  32     <p>Consolidation combines the cells of multiple cell ranges, using a
  33     specific function.</p>
  34
  35     @deprecated
  36  */
  37 published interface XConsolidatable: com::sun::star::uno::XInterface
  38 {
  39
  40     /** creates a consolidation descriptor.
  41
  42         @param bEmpty
  43             `TRUE` leaves the descriptor empty, `FALSE` fills it with
  44             the settings from the last consolidation action.
  45
  46         @see com::sun::star::sheet::ConsolidationDescriptor
  47      */
  48     com::sun::star::sheet::XConsolidationDescriptor createConsolidationDescriptor(
  49             [in] boolean bEmpty );
  50
  51
  52     /** consolidates data from several cell ranges, using the settings
  53         in the passed descriptor.
  54
  55         @param xDescriptor
  56             the descriptor used to perform the consolidation.
  57
  58         @see com::sun::star::sheet::ConsolidationDescriptor
  59      */
  60     void consolidate(
  61             [in] com::sun::star::sheet::XConsolidationDescriptor xDescriptor );
  62
  63 };
  64
  65
  66 }; }; }; };
  67
  68 #endif
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */