offapi/com/sun/star/sheet/DataPilotSourceLevel.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: DataPilotSourceLevel.idl,v $
  10  * $Revision: 1.7 $
  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_DataPilotSourceLevel_idl__
  32 #define __com_sun_star_sheet_DataPilotSourceLevel_idl__
  33
  34 #ifndef __com_sun_star_container_XNamed_idl__
  35 #include <com/sun/star/container/XNamed.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_sheet_XMembersSupplier_idl__
  39 #include <com/sun/star/sheet/XMembersSupplier.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_sheet_XDataPilotMemberResults_idl__
  43 #include <com/sun/star/sheet/XDataPilotMemberResults.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_beans_XPropertySet_idl__
  47 #include <com/sun/star/beans/XPropertySet.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_sheet_GeneralFunction_idl__
  51 #include <com/sun/star/sheet/GeneralFunction.idl>
  52 #endif
  53
  54 //=============================================================================
  55
  56  module com {  module sun {  module star {  module sheet {
  57
  58 //=============================================================================
  59
  60 /** represents a level in a data pilot source hierarchy.
  61
  62     @see com::sun::star::sheet::DataPilotSourceHierarchy
  63     @see com::sun::star::sheet::DataPilotSource
  64  */
  65 published service DataPilotSourceLevel
  66 {
  67     //-------------------------------------------------------------------------
  68
  69     /** provides access to the name of the level, i.e. used in collections.
  70      */
  71     interface com::sun::star::container::XNamed;
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** provides access to the collection of members of this level.
  76      */
  77     interface com::sun::star::sheet::XMembersSupplier;
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** provides access to a sequence of results of this level.
  82      */
  83     interface com::sun::star::sheet::XDataPilotMemberResults;
  84
  85     //-------------------------------------------------------------------------
  86
  87 //!published service PropertySet
  88     /** provides access to the properties.
  89      */
  90     interface com::sun::star::beans::XPropertySet;
  91
  92     //=========================================================================
  93
  94     /** specifies the subtotals that are inserted for the level.
  95
  96         <p>The subtotals are calculated with the members of this level.</p>
  97      */
  98     [property] sequence< com::sun::star::sheet::GeneralFunction > SubTotals;
  99
 100     //-------------------------------------------------------------------------
 101
 102     /** specifies whether empty members are shown.
 103      */
 104     [property] boolean ShowEmpty;
 105
 106 };
 107
 108 //=============================================================================
 109
 110 }; }; }; };
 111
 112 #endif
 113