summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/DataPilotSourceMember.idl
blob: 754fc955c30a9a36923d05b5f0d081f1deae8d0a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_DataPilotSourceMember_idl__
#define __com_sun_star_sheet_DataPilotSourceMember_idl__

#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** represents a member in a data pilot source level.

    <p>Members are the data items that will appear in a data pilot table
    as row headers and column headers of the data range (if used in
    row or column dimensions), or to calculate the values of the
    data range (if used in data dimensions).</p>

    @see com::sun::star::sheet::DataPilotSourceLevel
    @see com::sun::star::sheet::DataPilotSource
 */
published service DataPilotSourceMember
{
    //-------------------------------------------------------------------------

    /** provides access to the name of the member.

        <p>This may be the textual representation of a numerical value.</p>
     */
    interface com::sun::star::container::XNamed;

    //-------------------------------------------------------------------------

//!published service PropertySet
    /** provides access to the properties.
     */
    interface com::sun::star::beans::XPropertySet;

    //=========================================================================

    /** specifies whether the member is visible.
     */
    [property] boolean IsVisible;

    //-------------------------------------------------------------------------

    /** specifies whether details for the member are shown.
     */
    [property] boolean ShowDetails;

    //-------------------------------------------------------------------------

    /** specifies the member's position in its hierarchy level if sorting
        is manual.

        @since OOo 2.4.0
     */
    [optional, property] boolean Position;
};

//=============================================================================

}; }; }; };

#endif