offapi/com/sun/star/sheet/XSubTotalCalculatable.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: XSubTotalCalculatable.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_XSubTotalCalculatable_idl__
  32 #define __com_sun_star_sheet_XSubTotalCalculatable_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_XSubTotalDescriptor_idl__
  39 #include <com/sun/star/sheet/XSubTotalDescriptor.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** contains methods to handle a subtotal descriptor.
  49
  50     <p>The subtotal descriptor provides properties to set up the subtotal
  51     function.</p>
  52
  53     @see com::sun::star::sheet::SheetCellRange
  54     @see com::sun::star::sheet::SubTotalDescriptor
  55  */
  56 published interface XSubTotalCalculatable: com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59
  60     /** creates a subtotal descriptor.
  61
  62         @param bEmpty
  63             if set to <TRUE/>, creates an empty descriptor. If set to
  64             <FALSE/>, fills the descriptor with previous settings of the
  65             current object (i.e. a database range).
  66      */
  67     com::sun::star::sheet::XSubTotalDescriptor createSubTotalDescriptor(
  68             [in] boolean bEmpty );
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** creates subtotals using the settings of the passed descriptor.
  73
  74         @param xDescriptor
  75             the subtotal descriptor with the settings used for the subtotal
  76             operation.
  77
  78         @param bReplace
  79             if set to <TRUE/>, replaces previous subtotal results.
  80      */
  81     void applySubTotals(
  82             [in] com::sun::star::sheet::XSubTotalDescriptor xDescriptor,
  83             [in] boolean bReplace );
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** removes the subtotals from the current object.
  88      */
  89     void removeSubTotals();
  90
  91 };
  92
  93 //=============================================================================
  94
  95 }; }; }; };
  96
  97 #endif
  98