xref: /aoo42x/main/offapi/com/sun/star/chart/XDiagram.idl (revision cdf0e10c) 
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#ifndef __com_sun_star_chart_XDiagram_idl__
28#define __com_sun_star_chart_XDiagram_idl__
29
30#ifndef __com_sun_star_drawing_XShape_idl__
31#include <com/sun/star/drawing/XShape.idl>
32#endif
33
34#ifndef __com_sun_star_beans_XPropertySet_idl__
35#include <com/sun/star/beans/XPropertySet.idl>
36#endif
37
38#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
39#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
40#endif
41
42//=============================================================================
43
44 module com {  module sun {  module star {  module chart {
45
46//=============================================================================
47
48/** manages the diagram of the chart document.
49
50    @see XChartDocument
51 */
52published interface XDiagram: com::sun::star::drawing::XShape
53{
54	//-------------------------------------------------------------------------
55
56	/** @returns
57        	a string representing the diagram type. This string
58			contains the fully qualified name of the corresponding
59			service.
60	 */
61	string getDiagramType();
62
63	//-------------------------------------------------------------------------
64
65	/** @returns
66			the properties of the specified data row (series).
67
68        @param nRow
69        	the index of the series (0-based)
70
71        @see ChartDataRowProperties
72	 */
73	com::sun::star::beans::XPropertySet getDataRowProperties( [in] long nRow )
74		raises( com::sun::star::lang::IndexOutOfBoundsException );
75
76	//-------------------------------------------------------------------------
77
78	/** @returns
79			the properties of the specified data point.
80
81        @param nCol
82        	the index of the data point of a series (0-based).
83        @param nRow
84        	the index of a series (0-based).
85
86		@see ChartDataPointProperties
87	 */
88	com::sun::star::beans::XPropertySet getDataPointProperties( [in] long nCol,
89																[in] long nRow )
90		raises( com::sun::star::lang::IndexOutOfBoundsException );
91
92};
93
94//=============================================================================
95
96}; }; }; };
97
98#endif
99