blob: 32c2fdce1acb92b7459e4b3240d11b731466408a (
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/*************************************************************************
*
* 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_chart_XChartDocument_idl__
#define __com_sun_star_chart_XChartDocument_idl__
#ifndef __com_sun_star_frame_XModel_idl__
#include <com/sun/star/frame/XModel.idl>
#endif
#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_chart_XDiagram_idl__
#include <com/sun/star/chart/XDiagram.idl>
#endif
#ifndef __com_sun_star_chart_XChartData_idl__
#include <com/sun/star/chart/XChartData.idl>
#endif
//=============================================================================
module com { module sun { module star { module chart {
//=============================================================================
/** manages the chart document.
@see XDiagram
@see XChartData
*/
published interface XChartDocument: com::sun::star::frame::XModel
{
//-------------------------------------------------------------------------
/** @returns
the shape of the main title of the chart document.
@see ChartTitle
*/
com::sun::star::drawing::XShape getTitle();
//-------------------------------------------------------------------------
/** @returns
the shape of the subtitle of the chart document.
<p>Usually the subtitle is smaller than the main title by
default. And it is most commonly placed below the main title
by default.</p>
@see ChartTitle
*/
com::sun::star::drawing::XShape getSubTitle();
//-------------------------------------------------------------------------
/** @returns
the shape of the legend of the chart document.
@see ChartLegend
*/
com::sun::star::drawing::XShape getLegend();
//-------------------------------------------------------------------------
/** @returns
the properties of the background area of the chart document.
<p>The area's extent is equal to the document size. If you
want to access properties of the background area of the
diagram, in which the actual data is represented, you have to
change the chart wall which you get from the
<type>X3DDisplay</type>.</p>
@see ChartArea
@see X3DDisplay
*/
com::sun::star::beans::XPropertySet getArea();
//-------------------------------------------------------------------------
/** @returns
the diagram of the chart document.
@see Diagram
*/
com::sun::star::chart::XDiagram getDiagram();
//-------------------------------------------------------------------------
/** sets the diagram for the chart document.
<p>Setting a new diagram implicitly disposes the previous
diagram.</p>
@param xDiagram
the new diagram that should be set for the chart. To
create such a diagram component, you can use the
<type scope="com::sun::star::lang">XMultiServiceFactory</type>,
which should be implemented by an
<type>XChartDocument</type>.
*/
void setDiagram( [in] com::sun::star::chart::XDiagram xDiagram );
//-------------------------------------------------------------------------
/** @returns
the data of the chart.
<p>The returned object supports interface <type>XChartDataArray</type>
which can be used to access the concrete data.</p>
<p>Since OOo 3.3 the returned object also supports interface <type>XComplexDescriptionAccess</type>
which can be used to access complex hierarchical axis descriptions.</p>
<p>Since OOo 3.4 the returned object also supports interface <type>XDateCategories</type>.</p>
@see XChartData
@see XChartDataArray
@see XComplexDescriptionAccess
@see XDateCategories
*/
com::sun::star::chart::XChartData getData();
//-------------------------------------------------------------------------
/** attaches data to the chart.
<p>The given object needs to support interface <type>XChartDataArray</type>.</p>
<p>Since OOo 3.3 if the given object might support interface <type>XComplexDescriptionAccess</type>
which allows to set complex hierarchical axis descriptions.</p>
<p>Since OOo 3.4 if the given object might support interface <type>XDateCategories</type>
which allows to set date values as x values for category charts.</p>
<p>The given data is copied before it is applied to the chart.
So changing xData after this call will have no effect on the chart.</p>
@see XChartData
@see XChartDataArray
@see XComplexDescriptionAccess
@see XDateCategories
@param xData
the object that provides the new data.
*/
void attachData( [in] com::sun::star::chart::XChartData xData );
};
//=============================================================================
}; }; }; };
#endif
|
