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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#pragma once
#include <sal/config.h>
#include <string_view>
#include "TitleHelper.hxx"
#include "charttoolsdllapi.hxx"
#include <rtl/ustring.hxx>
#include <rtl/ref.hxx>
namespace chart { class ChartModel; }
namespace com::sun::star::awt { struct Point; }
namespace com::sun::star::beans { class XPropertySet; }
namespace com::sun::star::chart2 { class XAxis; }
namespace com::sun::star::chart2 { class XChartDocument; }
namespace com::sun::star::chart2 { class XCoordinateSystem; }
namespace com::sun::star::chart2 { class XDataSeries; }
namespace com::sun::star::chart2 { class XDiagram; }
namespace com::sun::star::drawing { class XShape; }
namespace com::sun::star::frame { class XModel; }
namespace com::sun::star::uno { class XInterface; }
namespace chart
{
class Axis;
class BaseCoordinateSystem;
class DataSeries;
class Diagram;
class Legend;
enum ObjectType
{
OBJECTTYPE_PAGE,
OBJECTTYPE_TITLE,
OBJECTTYPE_LEGEND,
OBJECTTYPE_LEGEND_ENTRY,
OBJECTTYPE_DIAGRAM,
OBJECTTYPE_DIAGRAM_WALL,
OBJECTTYPE_DIAGRAM_FLOOR,
OBJECTTYPE_AXIS,
OBJECTTYPE_AXIS_UNITLABEL,
OBJECTTYPE_GRID,
OBJECTTYPE_SUBGRID,
OBJECTTYPE_DATA_SERIES,
OBJECTTYPE_DATA_POINT,
OBJECTTYPE_DATA_LABELS,
OBJECTTYPE_DATA_LABEL,
OBJECTTYPE_DATA_ERRORS_X,
OBJECTTYPE_DATA_ERRORS_Y,
OBJECTTYPE_DATA_ERRORS_Z,
OBJECTTYPE_DATA_CURVE,//e.g. a statistical method printed as line
OBJECTTYPE_DATA_AVERAGE_LINE,
OBJECTTYPE_DATA_CURVE_EQUATION,
OBJECTTYPE_DATA_STOCK_RANGE,
OBJECTTYPE_DATA_STOCK_LOSS,
OBJECTTYPE_DATA_STOCK_GAIN,
OBJECTTYPE_SHAPE,
OBJECTTYPE_UNKNOWN
};
class OOO_DLLPUBLIC_CHARTTOOLS ObjectIdentifier
{
//CID == ClassifiedIdentifier <--> name of shape
//semicolon, colon, equal sign and slash have special meanings in a CID
//and are therefore not allowed in its components
//syntax of a CID: CID:/classification/ObjectID
//where classification: nothing or "MultiClick" or "DragMethod=DragMethodServiceName" and "DragParameter=DragParameterString"
// or a combination of these separated with a colon
//where DragMethodServiceName can be a selfdefined servicename for special actions //todo define standard service for this purpose
//where DragParameterString is any string you like to transport information to your special drag service
// only semicolon, colon, equal sign and slash are not allowed characters
// also the keywords used in the ObjectIdentifiers are not allowed
//where ObjectID: Parent-Particle:Particle //e.g. Series=2:Point=22
//where Particle: Type=ParticleID //e.g. Point=22
//where Type: getStringForType( ObjectType eType ) or other string
public:
ObjectIdentifier();
ObjectIdentifier( const OUString& rObjectCID );
ObjectIdentifier( const css::uno::Reference< css::drawing::XShape >& rxShape );
ObjectIdentifier( const css::uno::Any& rAny );
bool operator==( const ObjectIdentifier& rOID ) const;
bool operator!=( const ObjectIdentifier& rOID ) const;
bool operator<( const ObjectIdentifier& rOID ) const;
static OUString createClassifiedIdentifierForObject(
const css::uno::Reference< css::uno::XInterface >& xObject
, const rtl::Reference<::chart::ChartModel>& xChartModel );
static OUString createClassifiedIdentifierForObject(
const rtl::Reference< ::chart::Legend >& xObject
, const rtl::Reference<::chart::ChartModel>& xChartModel );
static OUString createClassifiedIdentifierForObject(
const rtl::Reference< ::chart::Axis >& xObject
, const rtl::Reference<::chart::ChartModel>& xChartModel );
static OUString createClassifiedIdentifierForParticle(
std::u16string_view rParticle );
static OUString createClassifiedIdentifierForParticles(
std::u16string_view rParentParticle
, std::u16string_view rChildParticle
, std::u16string_view rDragMethodServiceName = std::u16string_view()
, std::u16string_view rDragParameterString = std::u16string_view() );
static OUString createClassifiedIdentifierForGrid(
const css::uno::Reference< css::chart2::XAxis >& xAxis
, const rtl::Reference<::chart::ChartModel>& xChartModel
, sal_Int32 nSubIndex = -1 );//-1: main grid, 0: first subgrid etc
SAL_DLLPRIVATE static OUString createParticleForDiagram();
static OUString createParticleForCoordinateSystem(
const rtl::Reference< ::chart::BaseCoordinateSystem >& xCooSys
, const rtl::Reference<::chart::ChartModel>& xChartModel );
static OUString createParticleForAxis(
sal_Int32 nDimensionIndex, sal_Int32 nAxisIndex );
static OUString createParticleForGrid(
sal_Int32 nDimensionIndex, sal_Int32 nAxisIndex );
static OUString createParticleForSeries( sal_Int32 nDiagramIndex, sal_Int32 nCooSysIndex
, sal_Int32 nChartTypeIndex, sal_Int32 nSeriesIndex );
static OUString createParticleForLegend(
const rtl::Reference<::chart::ChartModel>& xChartModel );
static OUString addChildParticle( std::u16string_view rParticle, std::u16string_view rChildParticle );
static OUString createChildParticleWithIndex( ObjectType eObjectType, sal_Int32 nIndex );
static sal_Int32 getIndexFromParticleOrCID( const OUString& rParticleOrCID );
static OUString createClassifiedIdentifier(
enum ObjectType eObjectType //e.g. OBJECTTYPE_DATA_SERIES
, std::u16string_view rParticleID );//e.g. SeriesID
static OUString createClassifiedIdentifierWithParent(
enum ObjectType //e.g. OBJECTTYPE_DATA_POINT or OBJECTTYPE_GRID
, std::u16string_view rParticleID //for points or subgrids this is an Index or otherwise an identifier from the model object
, std::u16string_view rParentPartical //e.g. "Series=SeriesID" or "Grid=GridId"
, std::u16string_view rDragMethodServiceName = std::u16string_view()
, std::u16string_view rDragParameterString = std::u16string_view()
);
static bool isCID( std::u16string_view rName );
static std::u16string_view getDragMethodServiceName( std::u16string_view rClassifiedIdentifier );
static std::u16string_view getDragParameterString( std::u16string_view rCID );
static bool isDragableObject( std::u16string_view rClassifiedIdentifier );
bool isDragableObject() const;
static bool isRotateableObject( std::u16string_view rClassifiedIdentifier );
static bool isMultiClickObject( std::u16string_view rClassifiedIdentifier );
static bool areSiblings( const OUString& rCID1, const OUString& rCID2 );//identical object is no sibling
static bool areIdenticalObjects( const OUString& rCID1, const OUString& rCID2 );
static OUString getStringForType( ObjectType eObjectType );
static ObjectType getObjectType( std::u16string_view rCID );
ObjectType getObjectType() const;
static OUString createSeriesSubObjectStub( ObjectType eSubObjectType
, std::u16string_view rSeriesParticle
, std::u16string_view rDragMethodServiceName = std::u16string_view()
, std::u16string_view rDragParameterString = std::u16string_view() );
static OUString createPointCID( std::u16string_view rPointCID_Stub, sal_Int32 nIndex );
static OUString createDataCurveCID( std::u16string_view rSeriesParticle, sal_Int32 nCurveIndex, bool bAverageLine );
static OUString createDataCurveEquationCID( std::u16string_view rSeriesParticle, sal_Int32 nCurveIndex );
SAL_DLLPRIVATE static OUString getObjectID( const OUString& rCID );
static std::u16string_view getParticleID( std::u16string_view rCID );
static std::u16string_view getFullParentParticle( std::u16string_view rCID );
//returns the series particle of a CID when the CID is a child of the series
static OUString getSeriesParticleFromCID( const OUString& rCID );
//return the model object that is indicated by rObjectCID
static css::uno::Reference< css::beans::XPropertySet >
getObjectPropertySet(
const OUString& rObjectCID
, const rtl::Reference< ::chart::ChartModel >& xChartDocument );
//return the axis object that belongs to rObjectCID if any
static rtl::Reference< ::chart::Axis >
getAxisForCID(
const OUString& rObjectCID
, const rtl::Reference<::chart::ChartModel>& xChartModel );
//return the series object that belongs to rObjectCID if any
static rtl::Reference< ::chart::DataSeries >
getDataSeriesForCID(
const OUString& rObjectCID
, const rtl::Reference<::chart::ChartModel>& xChartModel );
static rtl::Reference< ::chart::Diagram >
getDiagramForCID(
const OUString& rObjectCID
, const rtl::Reference<::chart::ChartModel>& xChartModel );
static const OUString& getPieSegmentDragMethodServiceName();
static OUString createPieSegmentDragParameterString(
sal_Int32 nOffsetPercent
, const css::awt::Point& rMinimumPosition
, const css::awt::Point& rMaximumPosition );
static bool parsePieSegmentDragParameterString( std::u16string_view rDragParameterString
, sal_Int32& rOffsetPercent
, css::awt::Point& rMinimumPosition
, css::awt::Point& rMaximumPosition );
static TitleHelper::eTitleType getTitleTypeForCID( std::u16string_view rCID );
static OUString getMovedSeriesCID( const OUString& rObjectCID, bool bForward );
bool isValid() const;
bool isAutoGeneratedObject() const;
bool isAdditionalShape() const;
const OUString& getObjectCID() const { return m_aObjectCID;}
const css::uno::Reference< css::drawing::XShape >& getAdditionalShape() const { return m_xAdditionalShape;}
css::uno::Any getAny() const;
private:
// #i12587# support for shapes in chart
// For autogenerated chart objects a CID is specified in m_aObjectCID,
// for all other objects m_xAdditionalShape is set.
// Note, that if m_aObjectCID is set, m_xAdditionalShape must be empty
// and vice versa.
OUString m_aObjectCID;
css::uno::Reference< css::drawing::XShape > m_xAdditionalShape;
};
} //namespace chart
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
