offapi/com/sun/star/sheet/XSubTotalDescriptor.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: XSubTotalDescriptor.idl,v $
  10  * $Revision: 1.9 $
  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_XSubTotalDescriptor_idl__
  32 #define __com_sun_star_sheet_XSubTotalDescriptor_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_SubTotalColumn_idl__
  39 #include <com/sun/star/sheet/SubTotalColumn.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** provides access to the collection of subtotal fields in a subtotal
  49     descriptor.
  50
  51     @see com::sun::star::sheet::SubTotalDescriptor
  52  */
  53 published interface XSubTotalDescriptor: com::sun::star::uno::XInterface
  54 {
  55     //-------------------------------------------------------------------------
  56
  57     /** adds a subtotal field definition to the descriptor.
  58
  59         @param aSubTotalColumns
  60             a sequence of all columns used to calculate subtotal values.
  61
  62         @param nGroupColumn
  63             specifies which column of the source range is used to group the
  64             contents of the source data.
  65      */
  66     void addNew(
  67         [in] sequence< com::sun::star::sheet::SubTotalColumn > aSubTotalColumns,
  68         [in] long nGroupColumn );
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** removes all subtotal field definitions from the descriptor.
  73      */
  74     void clear();
  75
  76 };
  77
  78 //=============================================================================
  79
  80 }; }; }; };
  81
  82 #endif
  83