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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
|
/* -*- 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 "pcrcommon.hxx"
#include <com/sun/star/uno/XComponentContext.hpp>
#include <com/sun/star/beans/PropertyState.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/beans/Property.hpp>
#include <com/sun/star/script/XTypeConverter.hpp>
#include <com/sun/star/frame/XModel.hpp>
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/uno/Any.hxx>
#include <com/sun/star/util/Date.hpp>
#include <com/sun/star/util/Time.hpp>
#include <com/sun/star/util/DateTime.hpp>
#include <com/sun/star/inspection/XPropertyHandler.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <cppuhelper/basemutex.hxx>
#include <cppuhelper/compbase.hxx>
#include <cppuhelper/implbase1.hxx>
#include <comphelper/uno3.hxx>
#include <memory>
#include <vector>
namespace com::sun::star {
namespace inspection {
struct LineDescriptor;
class XPropertyControlFactory;
}
}
namespace weld { class Window; }
namespace pcr
{
typedef sal_Int32 PropertyId;
//= PropertyHandler
class OPropertyInfoService;
typedef ::cppu::WeakComponentImplHelper < css::inspection::XPropertyHandler
> PropertyHandler_Base;
/** the base class for property handlers
*/
class PropertyHandler : public ::cppu::BaseMutex
, public PropertyHandler_Base
{
private:
/// cache for getSupportedProperties
mutable StlSyntaxSequence< css::beans::Property >
m_aSupportedProperties;
mutable bool m_bSupportedPropertiesAreKnown;
private:
/// the property listener which has been registered
PropertyChangeListeners m_aPropertyListeners;
protected:
/// the context in which the instance was created
css::uno::Reference< css::uno::XComponentContext > m_xContext;
/// the component we're inspecting
css::uno::Reference< css::beans::XPropertySet > m_xComponent;
/// info about our component's properties
css::uno::Reference< css::beans::XPropertySetInfo > m_xComponentPropertyInfo;
/// type converter, needed on various occasions
css::uno::Reference< css::script::XTypeConverter > m_xTypeConverter;
/// access to property meta data
std::unique_ptr< OPropertyInfoService > m_pInfoService;
protected:
explicit PropertyHandler(
const css::uno::Reference< css::uno::XComponentContext >& _rxContext
);
virtual ~PropertyHandler() override;
// default implementations for XPropertyHandler
virtual void SAL_CALL inspect( const css::uno::Reference< css::uno::XInterface >& _rxIntrospectee ) override;
virtual css::uno::Sequence< css::beans::Property > SAL_CALL getSupportedProperties() override;
virtual css::uno::Sequence< OUString > SAL_CALL getSupersededProperties( ) override;
virtual css::uno::Sequence< OUString > SAL_CALL getActuatingProperties( ) override;
virtual css::uno::Any SAL_CALL convertToPropertyValue( const OUString& _rPropertyName, const css::uno::Any& _rControlValue ) override;
virtual css::uno::Any SAL_CALL convertToControlValue( const OUString& _rPropertyName, const css::uno::Any& _rPropertyValue, const css::uno::Type& _rControlValueType ) override;
virtual css::beans::PropertyState SAL_CALL getPropertyState( const OUString& _rPropertyName ) override;
virtual css::inspection::LineDescriptor SAL_CALL describePropertyLine( const OUString& _rPropertyName, const css::uno::Reference< css::inspection::XPropertyControlFactory >& _rxControlFactory ) override;
virtual sal_Bool SAL_CALL isComposable( const OUString& _rPropertyName ) override;
virtual css::inspection::InteractiveSelectionResult SAL_CALL onInteractivePropertySelection( const OUString& _rPropertyName, sal_Bool _bPrimary, css::uno::Any& _rData, const css::uno::Reference< css::inspection::XObjectInspectorUI >& _rxInspectorUI ) override;
virtual void SAL_CALL actuatingPropertyChanged( const OUString& _rActuatingPropertyName, const css::uno::Any& _rNewValue, const css::uno::Any& _rOldValue, const css::uno::Reference< css::inspection::XObjectInspectorUI >& _rxInspectorUI, sal_Bool _bFirstTimeInit ) override;
virtual void SAL_CALL addPropertyChangeListener( const css::uno::Reference< css::beans::XPropertyChangeListener >& _rxListener ) override;
virtual void SAL_CALL removePropertyChangeListener( const css::uno::Reference< css::beans::XPropertyChangeListener >& _rxListener ) override;
virtual sal_Bool SAL_CALL suspend( sal_Bool _bSuspend ) override;
// XComponent
DECLARE_XCOMPONENT()
virtual void SAL_CALL disposing() override;
// own overridables
virtual css::uno::Sequence< css::beans::Property >
doDescribeSupportedProperties() const = 0;
/// called when XPropertyHandler::inspect has been called, and we thus have a new component to inspect
virtual void onNewComponent();
protected:
/** fires the change in a property value to our listener (if any)
@see addPropertyChangeListener
*/
void firePropertyChange( const OUString& _rPropName, PropertyId _nPropId,
const css::uno::Any& _rOldValue, const css::uno::Any& _rNewValue );
/** retrieves a window which can be used as parent for dialogs
*/
weld::Window* impl_getDefaultDialogFrame_nothrow() const;
/** retrieves the property id for a given property name
@throw css::beans::UnknownPropertyException
if the property name is not known to our ->m_pInfoService
*/
PropertyId impl_getPropertyId_throwUnknownProperty( const OUString& _rPropertyName ) const;
/** retrieves the property id for a given property name
@throw css::uno::RuntimeException
if the property name is not known to our ->m_pInfoService
*/
PropertyId impl_getPropertyId_throwRuntime( const OUString& _rPropertyName ) const;
/** retrieves the property id for a given property name
@returns -1
if the property name is not known to our ->m_pInfoService
*/
PropertyId impl_getPropertyId_nothrow( const OUString& _rPropertyName ) const;
// helper for implementing doDescribeSupportedProperties
/** adds a description for the given string property to the given property vector
Most probably to be called from within getSupportedProperties
*/
inline void addStringPropertyDescription(
std::vector< css::beans::Property >& _rProperties,
const OUString& _rPropertyName
) const;
/** adds a description for the given int32 property to the given property vector
*/
inline void addInt32PropertyDescription(
std::vector< css::beans::Property >& _rProperties,
const OUString& _rPropertyName,
sal_Int16 _nAttribs = 0
) const;
/** adds a description for the given int16 property to the given property vector
*/
inline void addInt16PropertyDescription(
std::vector< css::beans::Property >& _rProperties,
const OUString& _rPropertyName,
sal_Int16 _nAttribs = 0
) const;
/** adds a description for the given double property to the given property vector
*/
inline void addDoublePropertyDescription(
std::vector< css::beans::Property >& _rProperties,
const OUString& _rPropertyName,
sal_Int16 _nAttribs
) const;
/** adds a description for the given date property to the given property vector
*/
inline void addDatePropertyDescription(
std::vector< css::beans::Property >& _rProperties,
const OUString& _rPropertyName,
sal_Int16 _nAttribs
) const;
/** adds a description for the given time property to the given property vector
*/
inline void addTimePropertyDescription(
std::vector< css::beans::Property >& _rProperties,
const OUString& _rPropertyName,
sal_Int16 _nAttribs
) const;
/** adds a description for the given DateTime property to the given property vector
*/
inline void addDateTimePropertyDescription(
std::vector< css::beans::Property >& _rProperties,
const OUString& _rPropertyName,
sal_Int16 _nAttribs
) const;
/// adds a Property, given by name only, to a given vector of Properties
void implAddPropertyDescription(
std::vector< css::beans::Property >& _rProperties,
const OUString& _rPropertyName,
const css::uno::Type& _rType,
sal_Int16 _nAttribs = 0
) const;
// helper for accessing and maintaining meta data about our supported properties
/** retrieves a property given by handle
@return
a pointer to the descriptor for the given properties, if it is one of our
supported properties, <NULL/> else.
@see doDescribeSupportedProperties
@see impl_getPropertyFromId_throw
*/
const css::beans::Property*
impl_getPropertyFromId_nothrow( PropertyId _nPropId ) const;
/** retrieves a property given by handle
@throws UnknownPropertyException
if the handler does not support a property with the given handle
@seealso doDescribeSupportedProperties
@see impl_getPropertyFromId_nothrow
*/
const css::beans::Property&
impl_getPropertyFromId_throw( PropertyId _nPropId ) const;
/** determines whether a given property id is part of our supported properties
@see getSupportedProperties
@see doDescribeSupportedProperties
*/
bool impl_isSupportedProperty_nothrow( PropertyId _nPropId ) const
{
return impl_getPropertyFromId_nothrow( _nPropId ) != nullptr;
}
/** retrieves a property given by name
@throws UnknownPropertyException
if the handler does not support a property with the given name
@seealso doDescribeSupportedProperties
*/
const css::beans::Property&
impl_getPropertyFromName_throw( const OUString& _rPropertyName ) const;
/** get the name of a property given by handle
*/
inline OUString
impl_getPropertyNameFromId_nothrow( PropertyId _nPropId ) const;
/** returns the value of the ContextDocument property in the ComponentContext which was used to create
this handler.
*/
css::uno::Reference< css::frame::XModel >
impl_getContextDocument_nothrow() const
{
return css::uno::Reference< css::frame::XModel >(
m_xContext->getValueByName( "ContextDocument" ), css::uno::UNO_QUERY );
}
/** marks the context document as modified
@see impl_getContextDocument_nothrow
*/
void impl_setContextDocumentModified_nothrow() const;
/// determines whether our component has a given property
bool impl_componentHasProperty_throw( const OUString& _rPropName ) const;
/** determines the default measure unit for the document in which our component lives
*/
sal_Int16 impl_getDocumentMeasurementUnit_throw() const;
private:
PropertyHandler( const PropertyHandler& ) = delete;
PropertyHandler& operator=( const PropertyHandler& ) = delete;
};
inline void PropertyHandler::addStringPropertyDescription( std::vector< css::beans::Property >& _rProperties, const OUString& _rPropertyName ) const
{
implAddPropertyDescription( _rProperties, _rPropertyName, ::cppu::UnoType<OUString>::get() );
}
inline void PropertyHandler::addInt32PropertyDescription( std::vector< css::beans::Property >& _rProperties, const OUString& _rPropertyName, sal_Int16 _nAttribs ) const
{
implAddPropertyDescription( _rProperties, _rPropertyName, ::cppu::UnoType<sal_Int32>::get(), _nAttribs );
}
inline void PropertyHandler::addInt16PropertyDescription( std::vector< css::beans::Property >& _rProperties, const OUString& _rPropertyName, sal_Int16 _nAttribs ) const
{
implAddPropertyDescription( _rProperties, _rPropertyName, ::cppu::UnoType<sal_Int16>::get(), _nAttribs );
}
inline void PropertyHandler::addDoublePropertyDescription( std::vector< css::beans::Property >& _rProperties, const OUString& _rPropertyName, sal_Int16 _nAttribs ) const
{
implAddPropertyDescription( _rProperties, _rPropertyName, ::cppu::UnoType<double>::get(), _nAttribs );
}
inline void PropertyHandler::addDatePropertyDescription( std::vector< css::beans::Property >& _rProperties, const OUString& _rPropertyName, sal_Int16 _nAttribs ) const
{
implAddPropertyDescription( _rProperties, _rPropertyName, ::cppu::UnoType<css::util::Date>::get(), _nAttribs );
}
inline void PropertyHandler::addTimePropertyDescription( std::vector< css::beans::Property >& _rProperties, const OUString& _rPropertyName, sal_Int16 _nAttribs ) const
{
implAddPropertyDescription( _rProperties, _rPropertyName, ::cppu::UnoType<css::util::Time>::get(), _nAttribs );
}
inline void PropertyHandler::addDateTimePropertyDescription( std::vector< css::beans::Property >& _rProperties, const OUString& _rPropertyName, sal_Int16 _nAttribs ) const
{
implAddPropertyDescription( _rProperties, _rPropertyName, ::cppu::UnoType<css::util::DateTime>::get(), _nAttribs );
}
inline OUString PropertyHandler::impl_getPropertyNameFromId_nothrow( PropertyId _nPropId ) const
{
const css::beans::Property* pProp = impl_getPropertyFromId_nothrow( _nPropId );
return pProp ? pProp->Name : OUString();
}
//= PropertyHandlerComponent
typedef ::cppu::ImplHelper1 < css::lang::XServiceInfo
> PropertyHandlerComponent_Base;
/** PropertyHandler implementation which additionally supports XServiceInfo
*/
class PropertyHandlerComponent :public PropertyHandler
,public PropertyHandlerComponent_Base
{
protected:
explicit PropertyHandlerComponent(
const css::uno::Reference< css::uno::XComponentContext >& _rxContext
);
DECLARE_XINTERFACE()
DECLARE_XTYPEPROVIDER()
// XServiceInfo
virtual OUString SAL_CALL getImplementationName( ) override = 0;
virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) final override;
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames( ) override = 0;
};
} // namespace pcr
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
