offapi/com/sun/star/sheet/DataPilotSourceLevel.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_DataPilotSourceLevel_idl__
  21 #define __com_sun_star_sheet_DataPilotSourceLevel_idl__
  22
  23 #include <com/sun/star/container/XNamed.idl>
  24 #include <com/sun/star/sheet/XMembersSupplier.idl>
  25 #include <com/sun/star/sheet/XDataPilotMemberResults.idl>
  26 #include <com/sun/star/beans/XPropertySet.idl>
  27 #include <com/sun/star/sheet/GeneralFunction.idl>
  28
  29
  30  module com {  module sun {  module star {  module sheet {
  31
  32
  33 /** represents a level in a data pilot source hierarchy.
  34
  35     @see com::sun::star::sheet::DataPilotSourceHierarchy
  36     @see com::sun::star::sheet::DataPilotSource
  37  */
  38 service DataPilotSourceLevel
  39 {
  40
  41     /** provides access to the name of the level, i.e. used in collections.
  42      */
  43     interface com::sun::star::container::XNamed;
  44
  45
  46     /** provides access to the collection of members of this level.
  47      */
  48     interface com::sun::star::sheet::XMembersSupplier;
  49
  50
  51     /** provides access to a sequence of results of this level.
  52      */
  53     interface com::sun::star::sheet::XDataPilotMemberResults;
  54
  55
  56 //!published service PropertySet
  57     /** provides access to the properties.
  58      */
  59     interface com::sun::star::beans::XPropertySet;
  60
  61
  62     /** specifies the subtotals that are inserted for the level.
  63
  64         <p>The subtotals are calculated with the members of this level.</p>
  65      */
  66     [property] sequence< com::sun::star::sheet::GeneralFunction > SubTotals;
  67
  68
  69     /** specifies whether empty members are shown.
  70      */
  71     [property] boolean ShowEmpty;
  72
  73 };
  74
  75
  76 }; }; }; };
  77
  78 #endif
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */