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