offapi/com/sun/star/sheet/XSubTotalField.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: XSubTotalField.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_XSubTotalField_idl__
  32 #define __com_sun_star_sheet_XSubTotalField_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 settings of a field in a subtotal descriptor.
  49
  50     @see com::sun::star::sheet::SubTotalField
  51     @see com::sun::star::sheet::SubTotalDescriptor
  52  */
  53 published interface XSubTotalField: com::sun::star::uno::XInterface
  54 {
  55     //-------------------------------------------------------------------------
  56
  57     /** returns the column by which entries are grouped.
  58      */
  59     long getGroupColumn();
  60
  61     //-------------------------------------------------------------------------
  62
  63     /** sets the column by which entries are grouped.
  64      */
  65     void setGroupColumn( [in] long nGroupColumn );
  66
  67     //-------------------------------------------------------------------------
  68
  69     /** returns the definitions of which columns should have subtotals
  70         added to them.
  71      */
  72     sequence< com::sun::star::sheet::SubTotalColumn > getSubTotalColumns();
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** sets the definitions of which columns should have subtotals
  77         added to them.
  78      */
  79     void setSubTotalColumns(
  80         [in] sequence< com::sun::star::sheet::SubTotalColumn >
  81             aSubTotalColumns );
  82
  83 };
  84
  85 //=============================================================================
  86
  87 }; }; }; };
  88
  89 #endif
  90