Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
4 : *
5 : * This Source Code Form is subject to the terms of the Mozilla Public
6 : * License, v. 2.0. If a copy of the MPL was not distributed with this
7 : * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 : *
9 : * This file incorporates work covered by the following license notice:
10 : *
11 : * Licensed to the Apache Software Foundation (ASF) under one or more
12 : * contributor license agreements. See the NOTICE file distributed
13 : * with this work for additional information regarding copyright
14 : * ownership. The ASF licenses this file to you under the Apache
15 : * License, Version 2.0 (the "License"); you may not use this file
16 : * except in compliance with the License. You may obtain a copy of
17 : * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 : */
19 :
20 : #ifndef EXTENSIONS_SOURCE_PROPCTRLR_PROPERTYHANDLER_HXX
21 : #define EXTENSIONS_SOURCE_PROPCTRLR_PROPERTYHANDLER_HXX
22 :
23 : #include "pcrcommon.hxx"
24 : #include "modulepcr.hxx"
25 :
26 : #include <com/sun/star/uno/XComponentContext.hpp>
27 : #include <com/sun/star/beans/PropertyState.hpp>
28 : #include <com/sun/star/beans/XPropertySet.hpp>
29 : #include <com/sun/star/beans/Property.hpp>
30 : #include <com/sun/star/script/XTypeConverter.hpp>
31 : #include <com/sun/star/frame/XModel.hpp>
32 : #include <com/sun/star/uno/Sequence.hxx>
33 : #include <com/sun/star/uno/Any.hxx>
34 : #include <com/sun/star/util/Date.hpp>
35 : #include <com/sun/star/util/Time.hpp>
36 : #include <com/sun/star/util/DateTime.hpp>
37 : #include <com/sun/star/lang/XMultiServiceFactory.hpp>
38 : #include <com/sun/star/inspection/XPropertyHandler.hpp>
39 : #include <com/sun/star/lang/XServiceInfo.hpp>
40 : #include <osl/interlck.h>
41 : #include <cppuhelper/compbase1.hxx>
42 : #include <cppuhelper/implbase1.hxx>
43 : #include <comphelper/uno3.hxx>
44 :
45 : #include <memory>
46 : #include <vector>
47 :
48 : namespace com { namespace sun { namespace star {
49 : namespace inspection {
50 : struct LineDescriptor;
51 : class XPropertyControlFactory;
52 : }
53 : } } }
54 :
55 : class Window;
56 : //........................................................................
57 : namespace pcr
58 : {
59 : //........................................................................
60 :
61 : typedef sal_Int32 PropertyId;
62 :
63 : //====================================================================
64 : //= PropertyHandler
65 : //====================================================================
66 : class OPropertyInfoService;
67 : typedef ::cppu::WeakComponentImplHelper1 < ::com::sun::star::inspection::XPropertyHandler
68 : > PropertyHandler_Base;
69 : /** the base class for property handlers
70 : */
71 : class PropertyHandler : public PropertyHandler_Base
72 : {
73 : private:
74 : /// cache for getSupportedProperties
75 : mutable StlSyntaxSequence< ::com::sun::star::beans::Property >
76 : m_aSupportedProperties;
77 : mutable bool m_bSupportedPropertiesAreKnown;
78 :
79 : /// helper which ensures that we can access resources as long as the instance lives
80 : PcrClient m_aEnsureResAccess;
81 :
82 : private:
83 : /// the property listener which has been registered
84 : PropertyChangeListeners m_aPropertyListeners;
85 :
86 : protected:
87 : mutable ::osl::Mutex m_aMutex;
88 : /// the context in which the instance was created
89 : ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > m_xContext;
90 : /// the component we're inspecting
91 : ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > m_xComponent;
92 : /// info about our component's properties
93 : ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > m_xComponentPropertyInfo;
94 : /// type converter, needed on various occasions
95 : ::com::sun::star::uno::Reference< ::com::sun::star::script::XTypeConverter > m_xTypeConverter;
96 : /// access to property meta data
97 : ::std::auto_ptr< OPropertyInfoService > m_pInfoService;
98 :
99 : protected:
100 : PropertyHandler(
101 : const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext
102 : );
103 : ~PropertyHandler();
104 :
105 : // default implementations for XPropertyHandler
106 : virtual void SAL_CALL inspect( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxIntrospectee ) throw (::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::NullPointerException);
107 : virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property > SAL_CALL getSupportedProperties() throw (::com::sun::star::uno::RuntimeException);
108 : virtual ::com::sun::star::uno::Sequence< OUString > SAL_CALL getSupersededProperties( ) throw (::com::sun::star::uno::RuntimeException);
109 : virtual ::com::sun::star::uno::Sequence< OUString > SAL_CALL getActuatingProperties( ) throw (::com::sun::star::uno::RuntimeException);
110 : virtual ::com::sun::star::uno::Any SAL_CALL convertToPropertyValue( const OUString& _rPropertyName, const ::com::sun::star::uno::Any& _rControlValue ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
111 : virtual ::com::sun::star::uno::Any SAL_CALL convertToControlValue( const OUString& _rPropertyName, const ::com::sun::star::uno::Any& _rPropertyValue, const ::com::sun::star::uno::Type& _rControlValueType ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
112 : virtual ::com::sun::star::beans::PropertyState SAL_CALL getPropertyState( const OUString& _rPropertyName ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
113 : virtual ::com::sun::star::inspection::LineDescriptor SAL_CALL describePropertyLine( const OUString& _rPropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyControlFactory >& _rxControlFactory ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::NullPointerException, ::com::sun::star::uno::RuntimeException);
114 : virtual ::sal_Bool SAL_CALL isComposable( const OUString& _rPropertyName ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
115 : virtual ::com::sun::star::inspection::InteractiveSelectionResult SAL_CALL onInteractivePropertySelection( const OUString& _rPropertyName, sal_Bool _bPrimary, ::com::sun::star::uno::Any& _rData, const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XObjectInspectorUI >& _rxInspectorUI ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::NullPointerException, ::com::sun::star::uno::RuntimeException);
116 : virtual void SAL_CALL actuatingPropertyChanged( const OUString& _rActuatingPropertyName, const ::com::sun::star::uno::Any& _rNewValue, const ::com::sun::star::uno::Any& _rOldValue, const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XObjectInspectorUI >& _rxInspectorUI, sal_Bool _bFirstTimeInit ) throw (::com::sun::star::lang::NullPointerException, ::com::sun::star::uno::RuntimeException);
117 : virtual void SAL_CALL addPropertyChangeListener( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& _rxListener ) throw (::com::sun::star::uno::RuntimeException);
118 : virtual void SAL_CALL removePropertyChangeListener( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& _rxListener ) throw (::com::sun::star::uno::RuntimeException);
119 : virtual sal_Bool SAL_CALL suspend( sal_Bool _bSuspend ) throw (::com::sun::star::uno::RuntimeException);
120 :
121 : // XComponent
122 : DECLARE_XCOMPONENT()
123 : virtual void SAL_CALL disposing();
124 :
125 : // own overridables
126 : virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property >
127 : SAL_CALL doDescribeSupportedProperties() const = 0;
128 :
129 : /// called when XPropertyHandler::inspect has been called, and we thus have a new component to inspect
130 : virtual void onNewComponent();
131 :
132 : protected:
133 : /** fires the change in a property value to our listener (if any)
134 : @see addPropertyChangeListener
135 : */
136 : void firePropertyChange( const OUString& _rPropName, PropertyId _nPropId,
137 : const ::com::sun::star::uno::Any& _rOldValue, const ::com::sun::star::uno::Any& _rNewValue ) SAL_THROW(());
138 :
139 : /** retrieves a window which can be used as parent for dialogs
140 : */
141 : Window* impl_getDefaultDialogParent_nothrow() const;
142 :
143 : /** retrieves the property id for a given property name
144 : @throw com::sun::star::beans::UnknownPropertyException
145 : if the property name is not known to our ->m_pInfoService
146 : */
147 : PropertyId impl_getPropertyId_throw( const OUString& _rPropertyName ) const;
148 :
149 : //-------------------------------------------------------------------------------
150 : // helper for implementing doDescribeSupportedProperties
151 : /** adds a description for the given string property to the given property vector
152 : Most probably to be called from within getSupportedProperties
153 : */
154 : inline void addStringPropertyDescription(
155 : ::std::vector< ::com::sun::star::beans::Property >& _rProperties,
156 : const OUString& _rPropertyName,
157 : sal_Int16 _nAttribs = 0
158 : ) const;
159 :
160 : /** adds a description for the given int32 property to the given property vector
161 : */
162 : inline void addInt32PropertyDescription(
163 : ::std::vector< ::com::sun::star::beans::Property >& _rProperties,
164 : const OUString& _rPropertyName,
165 : sal_Int16 _nAttribs = 0
166 : ) const;
167 :
168 : /** adds a description for the given int16 property to the given property vector
169 : */
170 : inline void addInt16PropertyDescription(
171 : ::std::vector< ::com::sun::star::beans::Property >& _rProperties,
172 : const OUString& _rPropertyName,
173 : sal_Int16 _nAttribs = 0
174 : ) const;
175 :
176 : /** adds a description for the given double property to the given property vector
177 : */
178 : inline void addDoublePropertyDescription(
179 : ::std::vector< ::com::sun::star::beans::Property >& _rProperties,
180 : const OUString& _rPropertyName,
181 : sal_Int16 _nAttribs = 0
182 : ) const;
183 :
184 : /** adds a description for the given date property to the given property vector
185 : */
186 : inline void addDatePropertyDescription(
187 : ::std::vector< ::com::sun::star::beans::Property >& _rProperties,
188 : const OUString& _rPropertyName,
189 : sal_Int16 _nAttribs = 0
190 : ) const;
191 :
192 : /** adds a description for the given time property to the given property vector
193 : */
194 : inline void addTimePropertyDescription(
195 : ::std::vector< ::com::sun::star::beans::Property >& _rProperties,
196 : const OUString& _rPropertyName,
197 : sal_Int16 _nAttribs = 0
198 : ) const;
199 :
200 : /** adds a description for the given DateTime property to the given property vector
201 : */
202 : inline void addDateTimePropertyDescription(
203 : ::std::vector< ::com::sun::star::beans::Property >& _rProperties,
204 : const OUString& _rPropertyName,
205 : sal_Int16 _nAttribs = 0
206 : ) const;
207 :
208 : /// adds a Property, given by name only, to a given vector of Properties
209 : void implAddPropertyDescription(
210 : ::std::vector< ::com::sun::star::beans::Property >& _rProperties,
211 : const OUString& _rPropertyName,
212 : const ::com::sun::star::uno::Type& _rType,
213 : sal_Int16 _nAttribs = 0
214 : ) const;
215 :
216 : //-------------------------------------------------------------------------------
217 : // helper for accessing and maintaining meta data about our supported properties
218 :
219 : /** retrieves a property given by handle
220 :
221 : @return
222 : a pointer to the descriptor for the given properties, if it is one of our
223 : supported properties, <NULL/> else.
224 :
225 : @see doDescribeSupportedProperties
226 : @see impl_getPropertyFromId_throw
227 : */
228 : const ::com::sun::star::beans::Property*
229 : impl_getPropertyFromId_nothrow( PropertyId _nPropId ) const;
230 :
231 : /** retrieves a property given by handle
232 :
233 : @throws UnknownPropertyException
234 : if the handler does not support a property with the given handle
235 :
236 : @seealso doDescribeSupportedProperties
237 : @see impl_getPropertyFromId_nothrow
238 : */
239 : const ::com::sun::star::beans::Property&
240 : impl_getPropertyFromId_throw( PropertyId _nPropId ) const;
241 :
242 : /** determines whether a given property id is part of our supported properties
243 : @see getSupportedProperties
244 : @see doDescribeSupportedProperties
245 : */
246 0 : inline bool impl_isSupportedProperty_nothrow( PropertyId _nPropId ) const
247 : {
248 0 : return impl_getPropertyFromId_nothrow( _nPropId ) != NULL;
249 : }
250 :
251 : /** retrieves a property given by name
252 :
253 : @throws UnknownPropertyException
254 : if the handler does not support a property with the given name
255 :
256 : @seealso doDescribeSupportedProperties
257 : */
258 : const ::com::sun::star::beans::Property&
259 : impl_getPropertyFromName_throw( const OUString& _rPropertyName ) const;
260 :
261 : /** get the name of a property given by handle
262 : */
263 : inline OUString
264 : impl_getPropertyNameFromId_nothrow( PropertyId _nPropId ) const;
265 :
266 : /** returns the value of the ContextDocument property in the ComponentContext which was used to create
267 : this handler.
268 : */
269 : inline ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >
270 0 : impl_getContextDocument_nothrow() const
271 : {
272 : return ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >(
273 0 : m_xContext->getValueByName( "ContextDocument" ), ::com::sun::star::uno::UNO_QUERY );
274 : }
275 :
276 : /** marks the context document as modified
277 :
278 : @see impl_getContextDocument_nothrow
279 : */
280 : void impl_setContextDocumentModified_nothrow() const;
281 :
282 : /// determines whether our component has a given property
283 : bool impl_componentHasProperty_throw( const OUString& _rPropName ) const;
284 :
285 : /** determines the default measure unit for the document in which our component lives
286 : */
287 : sal_Int16 impl_getDocumentMeasurementUnit_throw() const;
288 :
289 : private:
290 : PropertyHandler(); // never implemented
291 : PropertyHandler( const PropertyHandler& ); // never implemented
292 : PropertyHandler& operator=( const PropertyHandler& ); // never implemented
293 : };
294 :
295 : //--------------------------------------------------------------------
296 0 : inline void PropertyHandler::addStringPropertyDescription( ::std::vector< ::com::sun::star::beans::Property >& _rProperties, const OUString& _rPropertyName, sal_Int16 _nAttribs ) const
297 : {
298 0 : implAddPropertyDescription( _rProperties, _rPropertyName, ::getCppuType( static_cast< OUString* >( NULL ) ), _nAttribs );
299 0 : }
300 :
301 0 : inline void PropertyHandler::addInt32PropertyDescription( ::std::vector< ::com::sun::star::beans::Property >& _rProperties, const OUString& _rPropertyName, sal_Int16 _nAttribs ) const
302 : {
303 0 : implAddPropertyDescription( _rProperties, _rPropertyName, ::getCppuType( static_cast< sal_Int32* >( NULL ) ), _nAttribs );
304 0 : }
305 :
306 0 : inline void PropertyHandler::addInt16PropertyDescription( ::std::vector< ::com::sun::star::beans::Property >& _rProperties, const OUString& _rPropertyName, sal_Int16 _nAttribs ) const
307 : {
308 0 : implAddPropertyDescription( _rProperties, _rPropertyName, ::getCppuType( static_cast< sal_Int16* >( NULL ) ), _nAttribs );
309 0 : }
310 :
311 0 : inline void PropertyHandler::addDoublePropertyDescription( ::std::vector< ::com::sun::star::beans::Property >& _rProperties, const OUString& _rPropertyName, sal_Int16 _nAttribs ) const
312 : {
313 0 : implAddPropertyDescription( _rProperties, _rPropertyName, ::getCppuType( static_cast< double* >( NULL ) ), _nAttribs );
314 0 : }
315 :
316 0 : inline void PropertyHandler::addDatePropertyDescription( ::std::vector< ::com::sun::star::beans::Property >& _rProperties, const OUString& _rPropertyName, sal_Int16 _nAttribs ) const
317 : {
318 0 : implAddPropertyDescription( _rProperties, _rPropertyName, ::getCppuType( static_cast< com::sun::star::util::Date* >( NULL ) ), _nAttribs );
319 0 : }
320 :
321 0 : inline void PropertyHandler::addTimePropertyDescription( ::std::vector< ::com::sun::star::beans::Property >& _rProperties, const OUString& _rPropertyName, sal_Int16 _nAttribs ) const
322 : {
323 0 : implAddPropertyDescription( _rProperties, _rPropertyName, ::getCppuType( static_cast< com::sun::star::util::Time* >( NULL ) ), _nAttribs );
324 0 : }
325 :
326 0 : inline void PropertyHandler::addDateTimePropertyDescription( ::std::vector< ::com::sun::star::beans::Property >& _rProperties, const OUString& _rPropertyName, sal_Int16 _nAttribs ) const
327 : {
328 0 : implAddPropertyDescription( _rProperties, _rPropertyName, ::getCppuType( static_cast< com::sun::star::util::DateTime* >( NULL ) ), _nAttribs );
329 0 : }
330 :
331 0 : inline OUString PropertyHandler::impl_getPropertyNameFromId_nothrow( PropertyId _nPropId ) const
332 : {
333 0 : const ::com::sun::star::beans::Property* pProp = impl_getPropertyFromId_nothrow( _nPropId );
334 0 : return pProp ? pProp->Name : OUString();
335 : }
336 :
337 : //====================================================================
338 : //= PropertyHandlerComponent
339 : //====================================================================
340 : typedef ::cppu::ImplHelper1 < ::com::sun::star::lang::XServiceInfo
341 : > PropertyHandlerComponent_Base;
342 : /** PropertyHandler implementation which additionally supports XServiceInfo
343 : */
344 0 : class PropertyHandlerComponent :public PropertyHandler
345 : ,public PropertyHandlerComponent_Base
346 : {
347 : protected:
348 : PropertyHandlerComponent(
349 : const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext
350 : );
351 :
352 : DECLARE_XINTERFACE()
353 : DECLARE_XTYPEPROVIDER()
354 :
355 : // XServiceInfo
356 : virtual OUString SAL_CALL getImplementationName( ) throw (::com::sun::star::uno::RuntimeException) = 0;
357 : virtual ::sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) throw (::com::sun::star::uno::RuntimeException);
358 : virtual ::com::sun::star::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames( ) throw (::com::sun::star::uno::RuntimeException) = 0;
359 : };
360 :
361 : //====================================================================
362 : //= HandlerComponentBase
363 : //====================================================================
364 : /** a PropertyHandlerComponent implementation which routes XServiceInfo::getImplementationName and
365 : XServiceInfo::getSupportedServiceNames to static versions of those methods, which are part of
366 : the derived class.
367 :
368 : Additionally, a method <member>Create</member> is provided which takes a component context, and returns a new
369 : instance of the derived class. This <member>Create</member> is used to register the implementation
370 : of the derived class at the <type>PcrModule</type>.
371 :
372 : Well, every time we're talking about derived class, we in fact mean the template argument of
373 : <type>HandlerComponentBase</type>. But usually this equals your derived class:
374 : <pre>
375 : class MyHandler;
376 : typedef HandlerComponentBase< MyHandler > MyHandler_Base;
377 : class MyHandler : MyHandler_Base
378 : {
379 : ...
380 : public:
381 : static OUString SAL_CALL getImplementationName_static( ) throw (::com::sun::star::uno::RuntimeException);
382 : static ::com::sun::star::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames_static( ) throw (::com::sun::star::uno::RuntimeException);
383 : };
384 : </pre>
385 : */
386 : template < class HANDLER >
387 0 : class HandlerComponentBase : public PropertyHandlerComponent
388 : {
389 : protected:
390 0 : HandlerComponentBase( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext )
391 0 : :PropertyHandlerComponent( _rxContext )
392 : {
393 0 : }
394 :
395 : protected:
396 : // XServiceInfo
397 : virtual OUString SAL_CALL getImplementationName( ) throw (::com::sun::star::uno::RuntimeException);
398 : virtual ::com::sun::star::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames( ) throw (::com::sun::star::uno::RuntimeException);
399 : static ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL Create( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext );
400 :
401 : public:
402 : /** registers the implementation of HANDLER at the <type>PcrModule</type>
403 : */
404 : static void registerImplementation();
405 : };
406 :
407 : //--------------------------------------------------------------------
408 : template < class HANDLER >
409 0 : OUString SAL_CALL HandlerComponentBase< HANDLER >::getImplementationName( ) throw (::com::sun::star::uno::RuntimeException)
410 : {
411 0 : return HANDLER::getImplementationName_static();
412 : }
413 :
414 : //--------------------------------------------------------------------
415 : template < class HANDLER >
416 0 : ::com::sun::star::uno::Sequence< OUString > SAL_CALL HandlerComponentBase< HANDLER >::getSupportedServiceNames( ) throw (::com::sun::star::uno::RuntimeException)
417 : {
418 0 : return HANDLER::getSupportedServiceNames_static();
419 : }
420 :
421 : //--------------------------------------------------------------------
422 : template < class HANDLER >
423 8 : void HandlerComponentBase< HANDLER >::registerImplementation()
424 : {
425 8 : PcrModule::getInstance().registerImplementation(
426 : HANDLER::getImplementationName_static(),
427 : HANDLER::getSupportedServiceNames_static(),
428 : HANDLER::Create
429 : );
430 8 : }
431 :
432 : //--------------------------------------------------------------------
433 : template < class HANDLER >
434 0 : ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL HandlerComponentBase< HANDLER >::Create( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext )
435 : {
436 0 : return *( new HANDLER( _rxContext ) );
437 : }
438 :
439 : //........................................................................
440 : } // namespace pcr
441 : //........................................................................
442 :
443 : #endif // EXTENSIONS_SOURCE_PROPCTRLR_PROPERTYHANDLER_HXX
444 :
445 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
