/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XSubTotalCalculatable.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 05:22:51 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XSubTotalCalculatable_idl__
#define __com_sun_star_sheet_XSubTotalCalculatable_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__
#include <com/sun/star/sheet/XSubTotalDescriptor.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** contains methods to handle a subtotal descriptor.

    <p>The subtotal descriptor provides properties to set up the subtotal
    function.</p>

    @see com::sun::star::sheet::SheetCellRange
    @see com::sun::star::sheet::SubTotalDescriptor
 */
published interface XSubTotalCalculatable: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** creates a subtotal descriptor.

        @param bEmpty
            if set to <TRUE/>, creates an empty descriptor. If set to
            <FALSE/>, fills the descriptor with previous settings of the
            current object (i.e. a database range).
     */
    com::sun::star::sheet::XSubTotalDescriptor createSubTotalDescriptor(
            [in] boolean bEmpty );

    //-------------------------------------------------------------------------

    /** creates subtotals using the settings of the passed descriptor.

        @param xDescriptor
            the subtotal descriptor with the settings used for the subtotal
            operation.

        @param bReplace
            if set to <TRUE/>, replaces previous subtotal results.
     */
    void applySubTotals(
            [in] com::sun::star::sheet::XSubTotalDescriptor xDescriptor,
            [in] boolean bReplace );

    //-------------------------------------------------------------------------

    /** removes the subtotals from the current object.
     */
    void removeSubTotals();

};

//=============================================================================

}; }; }; };

#endif

