include/svx/shapepropertynotifier.hxx

   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 INCLUDED_SVX_SHAPEPROPERTYNOTIFIER_HXX
  21 #define INCLUDED_SVX_SHAPEPROPERTYNOTIFIER_HXX
  22
  23 #include <svx/svxdllapi.h>
  24 #include <svx/shapeproperty.hxx>
  25
  26 #include <com/sun/star/beans/PropertyChangeEvent.hpp>
  27 #include <com/sun/star/beans/XPropertyChangeListener.hpp>
  28
  29 #include <memory>
  30
  31 namespace cppu
  32 {
  33     class OWeakObject;
  34 }
  35
  36
  37 namespace svx
  38 {
  39
  40
  41     //= IPropertyValueProvider
  42
  43     /** a provider for a property value
  44     */
  45     class SVX_DLLPUBLIC IPropertyValueProvider
  46     {
  47     public:
  48         /** returns the name of the property which this provider is responsible for
  49         */
  50         virtual OUString getPropertyName() const = 0;
  51
  52         /** returns the current value of the property which the provider is responsible for
  53         */
  54         virtual void getCurrentValue( css::uno::Any& _out_rValue ) const = 0;
  55
  56         virtual ~IPropertyValueProvider();
  57     };
  58
  59     //= PropertyValueProvider
  60
  61     /** default implementation of a IPropertyValueProvider
  62
  63         This default implementation queries the object which it is constructed with for the XPropertySet interface,
  64         and calls the getPropertyValue method.
  65     */
  66     class SVX_DLLPUBLIC PropertyValueProvider   :public IPropertyValueProvider
  67     {
  68     public:
  69         PropertyValueProvider( ::cppu::OWeakObject& _rContext, const sal_Char* _pAsciiPropertyName )
  70             :m_rContext( _rContext )
  71             ,m_sPropertyName( OUString::createFromAscii( _pAsciiPropertyName ) )
  72         {
  73         }
  74
  75         virtual OUString getPropertyName() const override;
  76         virtual void getCurrentValue( css::uno::Any& _out_rValue ) const override;
  77
  78     protected:
  79         ::cppu::OWeakObject&    getContext() const { return m_rContext; }
  80         PropertyValueProvider(const PropertyValueProvider&) = delete;
  81         PropertyValueProvider& operator=(const PropertyValueProvider&) = delete;
  82
  83     private:
  84         ::cppu::OWeakObject&    m_rContext;
  85         const OUString   m_sPropertyName;
  86     };
  87
  88
  89     //= PropertyChangeNotifier
  90
  91     struct PropertyChangeNotifier_Data;
  92
  93     /** helper class for notifying XPropertyChangeListeners
  94
  95         The class is intended to be held as member of the class which does the property change broadcasting.
  96     */
  97     class SVX_DLLPUBLIC PropertyChangeNotifier
  98     {
  99     public:
 100         /** constructs a notifier instance
 101
 102             @param _rOwner
 103                 the owner instance of the notifier. Will be used as css.lang.EventObject.Source when
 104                 notifying events.
 105         */
 106         PropertyChangeNotifier( ::cppu::OWeakObject& _rOwner, ::osl::Mutex& _rMutex );
 107         ~PropertyChangeNotifier();
 108
 109         // listener maintenance
 110         void addPropertyChangeListener( const OUString& _rPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& _rxListener );
 111         void removePropertyChangeListener( const OUString& _rPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& _rxListener );
 112
 113         /** registers a IPropertyValueProvider
 114         */
 115         void    registerProvider( const ShapeProperty _eProperty, const std::shared_ptr<IPropertyValueProvider>& _rProvider );
 116
 117         /** notifies changes in the given property to all registered listeners
 118
 119             If no property value provider for the given property ID is registered, this is worth an assertion in a
 120             non-product build, and otherwise ignored.
 121         */
 122         void    notifyPropertyChange( const ShapeProperty _eProperty ) const;
 123
 124         /** is called to dispose the instance
 125         */
 126         void    disposing();
 127
 128     private:
 129         PropertyChangeNotifier(const PropertyChangeNotifier&) = delete;
 130         PropertyChangeNotifier& operator=(const PropertyChangeNotifier&) = delete;
 131
 132         std::unique_ptr< PropertyChangeNotifier_Data >  m_xData;
 133     };
 134
 135
 136 }
 137
 138
 139 #endif // INCLUDED_SVX_SHAPEPROPERTYNOTIFIER_HXX
 140
 141 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */