summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/chart/XDiagram.idl
blob: 9f279b50fd4ee5638eb100500f3fc75507a67424 (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
100
101
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XDiagram.idl,v $
 * $Revision: 1.12 $
 *
 * 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_chart_XDiagram_idl__
#define __com_sun_star_chart_XDiagram_idl__

#ifndef __com_sun_star_drawing_XShape_idl__
#include <com/sun/star/drawing/XShape.idl>
#endif

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

#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
#endif

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

 module com {  module sun {  module star {  module chart {

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

/** manages the diagram of the chart document.

    @see XChartDocument
 */
published interface XDiagram: com::sun::star::drawing::XShape
{
    //-------------------------------------------------------------------------

    /** @returns
            a string representing the diagram type. This string
            contains the fully qualified name of the corresponding
            service.
     */
    string getDiagramType();

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

    /** @returns
            the properties of the specified data row (series).

        @param nRow
            the index of the series (0-based)

        @see ChartDataRowProperties
     */
    com::sun::star::beans::XPropertySet getDataRowProperties( [in] long nRow )
        raises( com::sun::star::lang::IndexOutOfBoundsException );

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

    /** @returns
            the properties of the specified data point.

        @param nCol
            the index of the data point of a series (0-based).
        @param nRow
            the index of a series (0-based).

        @see ChartDataPointProperties
     */
    com::sun::star::beans::XPropertySet getDataPointProperties( [in] long nCol,
                                                                [in] long nRow )
        raises( com::sun::star::lang::IndexOutOfBoundsException );

};

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

}; }; }; };

#endif