extensions/source/propctrlr/cellbindinghandler.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_EXTENSIONS_SOURCE_PROPCTRLR_CELLBINDINGHANDLER_HXX
  21 #define INCLUDED_EXTENSIONS_SOURCE_PROPCTRLR_CELLBINDINGHANDLER_HXX
  22
  23 #include "propertyhandler.hxx"
  24
  25 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  26 #include <rtl/ref.hxx>
  27
  28 #include <memory>
  29
  30
  31 namespace pcr
  32 {
  33
  34
  35     class CellBindingHelper;
  36     class IPropertyEnumRepresentation;
  37
  38     class CellBindingPropertyHandler;
  39     typedef HandlerComponentBase< CellBindingPropertyHandler > CellBindingPropertyHandler_Base;
  40     class CellBindingPropertyHandler : public CellBindingPropertyHandler_Base
  41     {
  42     private:
  43         std::unique_ptr< CellBindingHelper >          m_pHelper;
  44         ::rtl::Reference< IPropertyEnumRepresentation > m_pCellExchangeConverter;
  45
  46     public:
  47         explicit CellBindingPropertyHandler(
  48             const css::uno::Reference< css::uno::XComponentContext >& _rxContext
  49         );
  50
  51         /// @throws css::uno::RuntimeException
  52         static OUString getImplementationName_static(  );
  53         /// @throws css::uno::RuntimeException
  54         static css::uno::Sequence< OUString > getSupportedServiceNames_static(  );
  55
  56     protected:
  57         virtual ~CellBindingPropertyHandler() override;
  58
  59     protected:
  60         // XPropertyHandler overriables
  61         virtual css::uno::Any                   SAL_CALL getPropertyValue( const OUString& _rPropertyName ) override;
  62         virtual void                            SAL_CALL setPropertyValue( const OUString& _rPropertyName, const css::uno::Any& _rValue ) override;
  63         virtual css::uno::Any                   SAL_CALL convertToPropertyValue( const OUString& _rPropertyName, const css::uno::Any& _rControlValue ) override;
  64         virtual css::uno::Any                   SAL_CALL convertToControlValue( const OUString& _rPropertyName, const css::uno::Any& _rPropertyValue, const css::uno::Type& _rControlValueType ) override;
  65         virtual css::uno::Sequence< OUString >  SAL_CALL getActuatingProperties( ) override;
  66         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;
  67
  68         // PropertyHandler overridables
  69         virtual css::uno::Sequence< css::beans::Property >
  70                                                 doDescribeSupportedProperties() const override;
  71         virtual void onNewComponent() override;
  72
  73     private:
  74         /** updates a property (UI) whose state depends on more than one other property
  75
  76             ->actuatingPropertyChanged is called for certain properties in whose changes
  77             we expressed interes (->getActuatingProperty). Now such a property change can
  78             result in simple UI updates, for instance another property being enabled or disabled.
  79
  80             However, it can also result in a more complex change: The current (UI) state might
  81             depend on the value of more than one other property. Those dependent properties (their
  82             UI, more precisely) are updated in this method.
  83
  84             @param _nPropid
  85                 the ->PropertyId of the dependent property whose UI state is to be updated
  86
  87             @param _rxInspectorUI
  88                 provides access to the property browser UI. Must not be <NULL/>.
  89         */
  90         void impl_updateDependentProperty_nothrow( PropertyId _nPropId, const css::uno::Reference< css::inspection::XObjectInspectorUI >& _rxInspectorUI ) const;
  91     };
  92
  93
  94 } // namespace pcr
  95
  96
  97 #endif // INCLUDED_EXTENSIONS_SOURCE_PROPCTRLR_CELLBINDINGHANDLER_HXX
  98
  99 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */