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