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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* 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 CHART2_DIAGRAMHELPER_HXX
#define CHART2_DIAGRAMHELPER_HXX
#include "StackMode.hxx"
#include "charttoolsdllapi.hxx"
#include <com/sun/star/chart2/XAxis.hpp>
#include <com/sun/star/chart2/XDiagram.hpp>
#include <com/sun/star/chart2/XChartTypeTemplate.hpp>
#include <com/sun/star/chart2/XCoordinateSystem.hpp>
#include <com/sun/star/chart2/InterpretedData.hpp>
#include <com/sun/star/chart2/StackingDirection.hpp>
#include <com/sun/star/chart2/XChartDocument.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <utility>
#include <vector>
namespace chart
{
enum DiagramPositioningMode
{
DiagramPositioningMode_AUTO,
DiagramPositioningMode_EXCLUDING,
DiagramPositioningMode_INCLUDING
};
class OOO_DLLPUBLIC_CHARTTOOLS DiagramHelper
{
public:
typedef ::std::pair<
::com::sun::star::uno::Reference<
::com::sun::star::chart2::XChartTypeTemplate >,
::rtl::OUString >
tTemplateWithServiceName;
/** tries to find a template in the chart-type manager that matches the
given diagram.
@param rPreferredTemplateName
Check this template first. This may speed up searching, if the
caller assumes a certain template as most likely to be the one that
matches.
@return
A pair containing a template with the correct properties set as
first entry and the service name of the templateas second entry. If
no template was found both elements are empty.
*/
static tTemplateWithServiceName
getTemplateForDiagram(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram > & xDiagram,
const ::com::sun::star::uno::Reference<
::com::sun::star::lang::XMultiServiceFactory > & xChartTypeManager,
const ::rtl::OUString & rPreferredTemplateName = ::rtl::OUString());
/** Sets the "SwapXAndYAxis" property at all coordinate systems found in the
given diagram.
"vertical==true" for bar charts, "vertical==false" for column charts
*/
static void setVertical( const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram > & xDiagram,
bool bVertical = true );
/** Gets the "SwapXAndYAxis" property at all coordinate systems found in the
given diagram.
"vertical==true" for bar charts, "vertical==false" for column charts
*/
static bool getVertical( const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram > & xDiagram,
bool& rbOutFoundResult, bool& rbOutAmbiguousResult );
static StackMode getStackMode(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram > & xDiagram,
bool& rbFound, bool& rbAmbiguous
);
/** @param bOnlyAtFirstChartType
If </TRUE>, the stacking mode is only set at the series found inside
the first chart type. This is the standard for all current
templates (the only template that has more than one chart-type and
allows stacking is bar/line combi, and for this the stacking only
applies to the first chart type/the bars)
*/
static void setStackMode(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram > & xDiagram,
StackMode eStackMode,
bool bOnlyAtFirstChartType = true
);
/** Retrieves the stackmode of the first DataSeries or none. If the series have differing stack
modes, rbAmbiguous is set to true. If no series is there rbFound is set to false.
@param xCorrespondingCoordinateSystem
The coordinate system in which the given chart type xChartType is
located. (This is needed for determining percent stacking. If
omitted, the result will just indicate "not stacked", "stacked" or
"ambiguous")
*/
static StackMode getStackModeFromChartType(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XChartType > & xChartType,
bool& rbFound, bool& rbAmbiguous,
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XCoordinateSystem > & xCorrespondingCoordinateSystem =
::com::sun::star::uno::Reference< ::com::sun::star::chart2::XCoordinateSystem >()
);
/** Returns the dimension found for all chart types in the tree. If the
dimension is not unique, 0 is returned.
*/
static sal_Int32 getDimension(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram > & xDiagram );
/** Sets the dimension of the diagram given.
1. Sets the dimension of all used ChartTypes
2. Adapts the DataSeriesTree to reflect the new dimension
3. If new coordinate-systems have to be created, adapts the
XCoordinateSystemContainer of the diagram.
*/
static void setDimension(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram > & xDiagram,
sal_Int32 nNewDimensionCount );
/** Replaces all occurences of xCooSysToReplace in the tree with
xReplacement in the diagram's tree
*/
SAL_DLLPRIVATE static void replaceCoordinateSystem(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram > & xDiagram,
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XCoordinateSystem > & xCooSysToReplace,
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XCoordinateSystem > & xReplacement );
static bool isSeriesAttachedToMainAxis(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDataSeries >& xDataSeries );
static bool attachSeriesToAxis( bool bMainAxis,
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDataSeries >& xSeries,
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram >& xDiagram,
const ::com::sun::star::uno::Reference<
::com::sun::star::uno::XComponentContext > & xContext,
bool bAdaptAxes=true );
static ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XAxis > getAttachedAxis(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDataSeries >& xSeries,
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram >& xDiagram );
static ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XChartType >
getChartTypeOfSeries(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram >& xDiagram,
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDataSeries >& xSeries );
static ::std::vector<
::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDataSeries > >
getDataSeriesFromDiagram(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram > & xDiagram );
/** return all data series in this diagram grouped by chart-types
*/
static ::com::sun::star::uno::Sequence<
::com::sun::star::uno::Sequence<
::com::sun::star::uno::Reference< ::com::sun::star::chart2::XDataSeries > > >
getDataSeriesGroups(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram > & xDiagram );
static bool isCategoryDiagram(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram >& xDiagram );
static void setCategoriesToDiagram(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::data::XLabeledDataSequence >& xCategories,
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram >& xDiagram,
bool bSetAxisType = false, // when this flag is true ...
bool bCategoryAxis = true);// set the AxisType to CATEGORY or back to REALNUMBER
static ::com::sun::star::uno::Reference< ::com::sun::star::chart2::data::XLabeledDataSequence >
getCategoriesFromDiagram(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram > & xDiagram );
static ::com::sun::star::uno::Sequence< rtl::OUString >
getExplicitSimpleCategories(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XChartDocument > & xChartDoc );
SAL_DLLPRIVATE static ::com::sun::star::uno::Sequence< rtl::OUString >
generateAutomaticCategoriesFromCooSys(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XCoordinateSystem > & xCooSys );
static ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XChartType >
getChartTypeByIndex( const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram >& xDiagram, sal_Int32 nIndex );
static ::com::sun::star::uno::Sequence<
::com::sun::star::uno::Reference<
::com::sun::star::chart2::XChartType > >
getChartTypesFromDiagram(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram > & xDiagram );
SAL_DLLPRIVATE static bool areChartTypesCompatible( const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XChartType >& xFirstType,
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XChartType >& xSecondType );
/**
* Test if a series can be moved.
*
* @param xDiagram
* Reference to the diagram that contains the series.
*
* @param xGivenDataSeries
* Reference to the series that should be tested for moving.
*
* @param bForward
* Direction of the move to be checked.
*
* @returns </TRUE> if the series can be moved.
*
*/
static bool isSeriesMoveable(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram >& xDiagram,
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDataSeries >& xGivenDataSeries,
bool bForward );
/**
* Move a series forward or backward.
*
* @param xDiagram
* Reference to the diagram that contains the series.
*
* @param xGivenDataSeries
* Reference to the series that should be moved.
*
* @param bForward
* Direction in which the series should be moved.
*
* @returns </TRUE> if the series was moved successfully.
*
*/
static bool moveSeries(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram >& xDiagram,
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDataSeries >& xGivenDataSeries,
bool bForward );
static bool isSupportingFloorAndWall( const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram > & xDiagram );
static bool isPieOrDonutChart( const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram >& xDiagram );
static sal_Int32 getGeometry3D(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram > & xDiagram,
bool& rbFound, bool& rbAmbiguous );
static void setGeometry3D(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram > & xDiagram,
sal_Int32 nNewGeometry );
//returns integer from constant group ::com::sun::star::chart::MissingValueTreatment
static sal_Int32 getCorrectedMissingValueTreatment(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram > & xDiagram,
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XChartType >& xChartType );
static DiagramPositioningMode getDiagramPositioningMode( const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDiagram > & xDiagram );
static bool setDiagramPositioning( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& xChartModel,
const ::com::sun::star::awt::Rectangle& rPosRect /*100th mm*/ );
static ::com::sun::star::awt::Rectangle getDiagramRectangleFromModel( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& xChartModel );
static bool switchDiagramPositioningToExcludingPositioning( const ::com::sun::star::uno::Reference<
::com::sun::star::frame::XModel >& xChartModel
, bool bResetModifiedState //set model back to unchanged if it was unchanged before
, bool bConvertAlsoFromAutoPositioning );
private:
// not implemented
DiagramHelper();
};
} // namespace chart
// CHART2_DIAGRAMHELPER_HXX
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
