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
  21  module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** represents a level in a data pilot source hierarchy.
  25
  26     @see com::sun::star::sheet::DataPilotSourceHierarchy
  27     @see com::sun::star::sheet::DataPilotSource
  28  */
  29 service DataPilotSourceLevel
  30 {
  31
  32     /** provides access to the name of the level, i.e. used in collections.
  33      */
  34     interface com::sun::star::container::XNamed;
  35
  36
  37     /** provides access to the collection of members of this level.
  38      */
  39     interface com::sun::star::sheet::XMembersSupplier;
  40
  41
  42     /** provides access to a sequence of results of this level.
  43      */
  44     interface com::sun::star::sheet::XDataPilotMemberResults;
  45
  46
  47 //!published service PropertySet
  48     /** provides access to the properties.
  49      */
  50     interface com::sun::star::beans::XPropertySet;
  51
  52
  53     /** specifies the subtotals that are inserted for the level.
  54
  55         <p>The subtotals are calculated with the members of this level.</p>
  56      */
  57     [property] sequence< com::sun::star::sheet::GeneralFunction > SubTotals;
  58
  59
  60     /** specifies whether empty members are shown.
  61      */
  62     [property] boolean ShowEmpty;
  63
  64
  65     /** specifies the subtotals that are inserted for the level.
  66
  67         <p>The subtotals are calculated with the members of this level.</p>
  68         @since LibreOffice 5.3
  69      */
  70     [property, optional] sequence< short > SubTotals2;
  71 };
  72
  73
  74 }; }; }; };
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */