offapi/com/sun/star/sheet/XSubTotalCalculatable.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_XSubTotalCalculatable_idl__
  29 #define __com_sun_star_sheet_XSubTotalCalculatable_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__
  36 #include <com/sun/star/sheet/XSubTotalDescriptor.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module sheet {
  42
  43 //=============================================================================
  44
  45 /** contains methods to handle a subtotal descriptor.
  46
  47     <p>The subtotal descriptor provides properties to set up the subtotal
  48     function.</p>
  49
  50     @see com::sun::star::sheet::SheetCellRange
  51     @see com::sun::star::sheet::SubTotalDescriptor
  52  */
  53 published interface XSubTotalCalculatable: com::sun::star::uno::XInterface
  54 {
  55     //-------------------------------------------------------------------------
  56
  57     /** creates a subtotal descriptor.
  58
  59         @param bEmpty
  60             if set to <TRUE/>, creates an empty descriptor. If set to
  61             <FALSE/>, fills the descriptor with previous settings of the
  62             current object (i.e. a database range).
  63      */
  64     com::sun::star::sheet::XSubTotalDescriptor createSubTotalDescriptor(
  65             [in] boolean bEmpty );
  66
  67     //-------------------------------------------------------------------------
  68
  69     /** creates subtotals using the settings of the passed descriptor.
  70
  71         @param xDescriptor
  72             the subtotal descriptor with the settings used for the subtotal
  73             operation.
  74
  75         @param bReplace
  76             if set to <TRUE/>, replaces previous subtotal results.
  77      */
  78     void applySubTotals(
  79             [in] com::sun::star::sheet::XSubTotalDescriptor xDescriptor,
  80             [in] boolean bReplace );
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** removes the subtotals from the current object.
  85      */
  86     void removeSubTotals();
  87
  88 };
  89
  90 //=============================================================================
  91
  92 }; }; }; };
  93
  94 #endif
  95