extensions/source/propctrlr/eformspropertyhandler.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_EFORMSPROPERTYHANDLER_HXX
  21 #define INCLUDED_EXTENSIONS_SOURCE_PROPCTRLR_EFORMSPROPERTYHANDLER_HXX
  22
  23 #include "propertyhandler.hxx"
  24
  25 #include <memory>
  26
  27
  28 namespace pcr
  29 {
  30
  31
  32     class EFormsHelper;
  33
  34     //= EFormsPropertyHandler
  35
  36     class EFormsPropertyHandler;
  37     typedef HandlerComponentBase< EFormsPropertyHandler > EFormsPropertyHandler_Base;
  38     class EFormsPropertyHandler : public EFormsPropertyHandler_Base
  39     {
  40     private:
  41         std::unique_ptr< EFormsHelper > m_pHelper;
  42         /** current value of the Model property, if there is no binding, yet
  43         */
  44         OUString                 m_sBindingLessModelName;
  45         /** are we currently simulating a propertyChange event of the Model property?
  46         */
  47         bool                            m_bSimulatingModelChange;
  48
  49     public:
  50         explicit EFormsPropertyHandler(
  51             const css::uno::Reference< css::uno::XComponentContext >& _rxContext
  52         );
  53
  54         /// @throws css::uno::RuntimeException
  55         static OUString getImplementationName_static(  );
  56         /// @throws css::uno::RuntimeException
  57         static css::uno::Sequence< OUString > getSupportedServiceNames_static(  );
  58
  59     protected:
  60         virtual ~EFormsPropertyHandler() override;
  61
  62     protected:
  63         // XPropertyHandler overriables
  64         virtual css::uno::Any                       SAL_CALL getPropertyValue( const OUString& _rPropertyName ) override;
  65         virtual void                                SAL_CALL setPropertyValue( const OUString& _rPropertyName, const css::uno::Any& _rValue ) override;
  66         virtual css::uno::Sequence< OUString >
  67                                                     SAL_CALL getActuatingProperties( ) override;
  68         virtual css::uno::Sequence< OUString >
  69                                                     SAL_CALL getSupersededProperties( ) override;
  70         virtual css::inspection::LineDescriptor
  71                                                     SAL_CALL describePropertyLine( const OUString& _rPropertyName, const css::uno::Reference< css::inspection::XPropertyControlFactory >& _rxControlFactory ) override;
  72         virtual css::inspection::InteractiveSelectionResult
  73                                                     SAL_CALL onInteractivePropertySelection( const OUString& _rPropertyName, sal_Bool _bPrimary, css::uno::Any& _rData, const css::uno::Reference< css::inspection::XObjectInspectorUI >& _rxInspectorUI ) override;
  74         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 ) override;
  75         virtual css::uno::Any                       SAL_CALL convertToPropertyValue( const OUString& _rPropertyName, const css::uno::Any& _rControlValue ) override;
  76         virtual css::uno::Any                       SAL_CALL convertToControlValue( const OUString& _rPropertyName, const css::uno::Any& _rPropertyValue, const css::uno::Type& _rControlValueType ) override;
  77         virtual void                                SAL_CALL addPropertyChangeListener( const css::uno::Reference< css::beans::XPropertyChangeListener >& _rxListener ) override;
  78         virtual void                                SAL_CALL removePropertyChangeListener( const css::uno::Reference< css::beans::XPropertyChangeListener >& _rxListener ) override;
  79
  80         // PropertyHandler overridables
  81         virtual css::uno::Sequence< css::beans::Property >
  82                                                     doDescribeSupportedProperties() const override;
  83         virtual void onNewComponent() override;
  84
  85     protected:
  86         /** returns the value of the PROPERTY_XML_DATA_MODEL property.
  87
  88             An extra method is necessary here, which respects both the value set at our helper,
  89             and <member>m_sBindingLessModelName</member>
  90         */
  91         OUString getModelNamePropertyValue() const;
  92     };
  93
  94
  95 } // namespace pcr
  96
  97
  98 #endif // INCLUDED_EXTENSIONS_SOURCE_PROPCTRLR_EFORMSPROPERTYHANDLER_HXX
  99
 100 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */