chart2/source/inc/OPropertySet.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 #pragma once
  20
  21 // helper classes
  22 #include <cppuhelper/propshlp.hxx>
  23
  24 // interfaces and types
  25 #include <com/sun/star/lang/XTypeProvider.hpp>
  26 #include <com/sun/star/beans/XPropertyState.hpp>
  27 #include <com/sun/star/beans/XMultiPropertyStates.hpp>
  28 #include <com/sun/star/style/XStyleSupplier.hpp>
  29
  30 #include <memory>
  31
  32 namespace property
  33 {
  34
  35 namespace impl
  36 { class ImplOPropertySet; }
  37
  38 class OPropertySet :
  39     public ::cppu::OBroadcastHelper,
  40     // includes beans::XPropertySet, XMultiPropertySet and XFastPropertySet
  41     public ::cppu::OPropertySetHelper,
  42     // includes uno::XWeak (and XInterface, esp. ref-counting)
  43
  44     public css::lang::XTypeProvider,
  45     public css::beans::XPropertyState,
  46     public css::beans::XMultiPropertyStates,
  47     public css::style::XStyleSupplier
  48 {
  49 public:
  50     OPropertySet( ::osl::Mutex & rMutex );
  51     virtual ~OPropertySet();
  52
  53 protected:
  54     explicit OPropertySet( const OPropertySet & rOther, ::osl::Mutex & rMutex );
  55
  56     void SetNewValuesExplicitlyEvenIfTheyEqualDefault();
  57
  58     /** implement this method to provide default values for all properties
  59         supporting defaults.  If a property does not have a default value, you
  60         may throw an UnknownPropertyException.
  61
  62         @throws css::beans::UnknownPropertyException
  63         @throws css::uno::RuntimeException
  64      */
  65     virtual css::uno::Any GetDefaultValue( sal_Int32 nHandle ) const = 0;
  66
  67     /** The InfoHelper table contains all property names and types of
  68         this object.
  69
  70         @return the object that provides information for the
  71                 PropertySetInfo
  72
  73         @see ::cppu::OPropertySetHelper
  74      */
  75     virtual ::cppu::IPropertyArrayHelper & SAL_CALL getInfoHelper() override = 0;
  76
  77     /** Try to convert the value <code>rValue</code> to the type required by the
  78         property associated with <code>nHandle</code>.
  79
  80         Override this method to take influence in modification of properties.
  81
  82         If the conversion changed , </sal_True> is returned and the converted value
  83         is in <code>rConvertedValue</code>.  The former value is contained in
  84         <code>rOldValue</code>.
  85
  86         After this call returns successfully, the vetoable listeners are
  87         notified.
  88
  89         @throws IllegalArgumentException, if the conversion was not successful,
  90                 or if there is no corresponding property to the given handle.
  91
  92         @param rConvertedValue the converted value. Only set if return is true.
  93         @param rOldValue the old value. Only set if return is true.
  94         @param nHandle the handle of the property.
  95
  96         @return true, if the conversion was successful and converted value
  97                 differs from the old value.
  98
  99         @see ::cppu::OPropertySetHelper
 100      */
 101     virtual sal_Bool SAL_CALL convertFastPropertyValue
 102         ( css::uno::Any & rConvertedValue,
 103           css::uno::Any & rOldValue,
 104           sal_Int32 nHandle,
 105           const css::uno::Any& rValue ) override;
 106
 107     /** The same as setFastPropertyValue; nHandle is always valid.
 108         The changes must not be broadcasted in this method.
 109
 110         @attention
 111         Although you are permitted to throw any UNO exception, only the following
 112         are valid for usage:
 113         -- css::beans::UnknownPropertyException
 114         -- css::beans::PropertyVetoException
 115         -- css::lang::IllegalArgumentException
 116         -- css::lang::WrappedTargetException
 117         -- css::uno::RuntimeException
 118
 119         @param nHandle handle
 120         @param rValue  value
 121
 122         @see ::cppu::OPropertySetHelper
 123     */
 124     virtual void SAL_CALL setFastPropertyValue_NoBroadcast
 125         ( sal_Int32 nHandle,
 126           const css::uno::Any& rValue ) override;
 127
 128     /**
 129        The same as getFastPropertyValue, but return the value through rValue and
 130        nHandle is always valid.
 131
 132         @see ::cppu::OPropertySetHelper
 133      */
 134     virtual void SAL_CALL getFastPropertyValue
 135         ( css::uno::Any& rValue,
 136           sal_Int32 nHandle ) const override;
 137
 138     /// make original interface function visible again
 139     using ::com::sun::star::beans::XFastPropertySet::getFastPropertyValue;
 140
 141     /** implement this method in derived classes to get called when properties
 142         change.
 143      */
 144     virtual void firePropertyChangeEvent();
 145
 146     // Interfaces
 147
 148     // ____ XInterface ____
 149     virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& aType ) override;
 150
 151     // ____ XTypeProvider ____
 152     virtual css::uno::Sequence< css::uno::Type > SAL_CALL
 153         getTypes() override;
 154     virtual css::uno::Sequence< sal_Int8 > SAL_CALL
 155         getImplementationId() override;
 156
 157     // ____ XPropertyState ____
 158     virtual css::beans::PropertyState SAL_CALL
 159         getPropertyState( const OUString& PropertyName ) override;
 160     virtual css::uno::Sequence< css::beans::PropertyState > SAL_CALL
 161         getPropertyStates( const css::uno::Sequence< OUString >& aPropertyName ) override;
 162     virtual void SAL_CALL
 163         setPropertyToDefault( const OUString& PropertyName ) override;
 164     virtual css::uno::Any SAL_CALL
 165         getPropertyDefault( const OUString& aPropertyName ) override;
 166
 167     // ____ XMultiPropertyStates ____
 168     // Note: getPropertyStates() is already implemented in XPropertyState with the
 169     // same signature
 170     virtual void SAL_CALL
 171         setAllPropertiesToDefault() override;
 172     virtual void SAL_CALL
 173         setPropertiesToDefault( const css::uno::Sequence< OUString >& aPropertyNames ) override;
 174     virtual css::uno::Sequence< css::uno::Any > SAL_CALL
 175         getPropertyDefaults( const css::uno::Sequence< OUString >& aPropertyNames ) override;
 176
 177     // ____ XStyleSupplier ____
 178     virtual css::uno::Reference< css::style::XStyle > SAL_CALL getStyle() override;
 179     virtual void SAL_CALL setStyle( const css::uno::Reference< css::style::XStyle >& xStyle ) override;
 180
 181     // ____ XMultiPropertySet ____
 182     virtual void SAL_CALL setPropertyValues(
 183         const css::uno::Sequence< OUString >& PropertyNames,
 184         const css::uno::Sequence< css::uno::Any >& Values ) override;
 185
 186     // ____ XFastPropertySet ____
 187     virtual void SAL_CALL setFastPropertyValue( sal_Int32 nHandle, const css::uno::Any& rValue ) override;
 188
 189     // Note: it is assumed that the base class implements setPropertyValue by
 190     // using setFastPropertyValue
 191
 192 private:
 193     /// reference to mutex of class deriving from here
 194     ::osl::Mutex &   m_rMutex;
 195
 196     /// pImpl idiom implementation
 197     std::unique_ptr< impl::ImplOPropertySet > m_pImplProperties;
 198     bool m_bSetNewValuesExplicitlyEvenIfTheyEqualDefault;
 199 };
 200
 201 } //  namespace property
 202
 203 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */