Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 431 insertions, 0 deletions

diff --git a/extensions/source/propctrlr/submissionhandler.cxx b/extensions/source/propctrlr/submissionhandler.cxx
new file mode 100644
index 000000000..87609e905
--- /dev/null
+++ b/extensions/source/propctrlr/submissionhandler.cxx
@@ -0,0 +1,431 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#include <sal/config.h>
+
+#include "submissionhandler.hxx"
+#include "formmetadata.hxx"
+#include "formstrings.hxx"
+#include "handlerhelper.hxx"
+
+#include <com/sun/star/form/FormButtonType.hpp>
+#include <com/sun/star/form/submission/XSubmissionSupplier.hpp>
+#include <com/sun/star/inspection/XObjectInspectorUI.hpp>
+#include <com/sun/star/lang/NullPointerException.hpp>
+#include <tools/debug.hxx>
+#include <tools/diagnose_ex.h>
+
+
+namespace pcr
+{
+
+
+    using namespace ::comphelper;
+    using namespace ::com::sun::star;
+    using namespace ::com::sun::star::uno;
+    using namespace ::com::sun::star::lang;
+    using namespace ::com::sun::star::beans;
+    using namespace ::com::sun::star::script;
+    using namespace ::com::sun::star::form;
+    using namespace ::com::sun::star::xforms;
+    using namespace ::com::sun::star::container;
+    using namespace ::com::sun::star::inspection;
+
+
+    //= SubmissionHelper
+
+
+    SubmissionHelper::SubmissionHelper( ::osl::Mutex& _rMutex, const Reference< XPropertySet >& _rxIntrospectee, const Reference< frame::XModel >& _rxContextDocument )
+        :EFormsHelper( _rMutex, _rxIntrospectee, _rxContextDocument )
+    {
+        OSL_ENSURE( canTriggerSubmissions( _rxIntrospectee, _rxContextDocument ),
+            "SubmissionHelper::SubmissionHelper: you should not have instantiated me!" );
+    }
+
+
+    bool SubmissionHelper::canTriggerSubmissions( const Reference< XPropertySet >& _rxControlModel,
+        const Reference< frame::XModel >& _rxContextDocument )
+    {
+        if ( !EFormsHelper::isEForm( _rxContextDocument ) )
+            return false;
+
+        try
+        {
+            Reference< submission::XSubmissionSupplier > xSubmissionSupp( _rxControlModel, UNO_QUERY );
+            if ( xSubmissionSupp.is() )
+                return true;
+        }
+        catch( const Exception& )
+        {
+            TOOLS_WARN_EXCEPTION( "extensions.propctrlr", "SubmissionHelper::canTriggerSubmissions" );
+        }
+        return false;
+    }
+
+
+    //= SubmissionPropertyHandler
+
+
+    SubmissionPropertyHandler::SubmissionPropertyHandler( const Reference< XComponentContext >& _rxContext )
+        :PropertyHandlerComponent( _rxContext )
+        ,OPropertyChangeListener( m_aMutex )
+    {
+    }
+
+
+    SubmissionPropertyHandler::~SubmissionPropertyHandler( )
+    {
+        disposeAdapter();
+    }
+
+
+    OUString SubmissionPropertyHandler::getImplementationName(  )
+    {
+        return "com.sun.star.comp.extensions.SubmissionPropertyHandler";
+    }
+
+
+    Sequence< OUString > SubmissionPropertyHandler::getSupportedServiceNames(  )
+    {
+        return { "com.sun.star.form.inspection.SubmissionPropertyHandler" };
+    }
+
+
+    Any SAL_CALL SubmissionPropertyHandler::getPropertyValue( const OUString& _rPropertyName )
+    {
+        ::osl::MutexGuard aGuard( m_aMutex );
+        PropertyId nPropId( impl_getPropertyId_throwUnknownProperty( _rPropertyName ) );
+
+        OSL_ENSURE(m_pHelper, "SubmissionPropertyHandler::getPropertyValue: inconsistency!");
+        // if we survived impl_getPropertyId_throwUnknownProperty, we should have a helper, since no helper implies no properties
+
+        Any aReturn;
+        try
+        {
+            switch ( nPropId )
+            {
+            case PROPERTY_ID_SUBMISSION_ID:
+            {
+                Reference< submission::XSubmissionSupplier > xSubmissionSupp( m_xComponent, UNO_QUERY );
+                OSL_ENSURE( xSubmissionSupp.is(), "SubmissionPropertyHandler::getPropertyValue: this should never happen ..." );
+                    // this handler is not intended for components which are no XSubmissionSupplier
+                Reference< submission::XSubmission > xSubmission;
+                if ( xSubmissionSupp.is() )
+                    xSubmission = xSubmissionSupp->getSubmission( );
+                aReturn <<= xSubmission;
+            }
+            break;
+
+            case PROPERTY_ID_XFORMS_BUTTONTYPE:
+            {
+                FormButtonType eType = FormButtonType_PUSH;
+                OSL_VERIFY( m_xComponent->getPropertyValue( PROPERTY_BUTTONTYPE ) >>= eType );
+                if ( ( eType != FormButtonType_PUSH ) && ( eType != FormButtonType_SUBMIT ) )
+                    eType = FormButtonType_PUSH;
+                aReturn <<= eType;
+            }
+            break;
+
+            default:
+                OSL_FAIL( "SubmissionPropertyHandler::getPropertyValue: cannot handle this property!" );
+                break;
+            }
+        }
+        catch( const Exception& )
+        {
+            TOOLS_WARN_EXCEPTION( "extensions.propctrlr", "SubmissionPropertyHandler::getPropertyValue" );
+        }
+
+        return aReturn;
+    }
+
+
+    void SAL_CALL SubmissionPropertyHandler::setPropertyValue( const OUString& _rPropertyName, const Any& _rValue )
+    {
+        ::osl::MutexGuard aGuard( m_aMutex );
+        PropertyId nPropId( impl_getPropertyId_throwUnknownProperty( _rPropertyName ) );
+
+        OSL_ENSURE(m_pHelper, "SubmissionPropertyHandler::setPropertyValue: inconsistency!");
+        // if we survived impl_getPropertyId_throwUnknownProperty, we should have a helper, since no helper implies no properties
+
+        try
+        {
+            switch ( nPropId )
+            {
+            case PROPERTY_ID_SUBMISSION_ID:
+            {
+                Reference< submission::XSubmission > xSubmission;
+                OSL_VERIFY( _rValue >>= xSubmission );
+
+                Reference< submission::XSubmissionSupplier > xSubmissionSupp( m_xComponent, UNO_QUERY );
+                OSL_ENSURE( xSubmissionSupp.is(), "SubmissionPropertyHandler::setPropertyValue: this should never happen ..." );
+                    // this handler is not intended for components which are no XSubmissionSupplier
+                if ( xSubmissionSupp.is() )
+                {
+                    xSubmissionSupp->setSubmission( xSubmission );
+                    impl_setContextDocumentModified_nothrow();
+                }
+            }
+            break;
+
+            case PROPERTY_ID_XFORMS_BUTTONTYPE:
+                m_xComponent->setPropertyValue( PROPERTY_BUTTONTYPE, _rValue );
+                break;
+
+            default:
+                OSL_FAIL( "SubmissionPropertyHandler::setPropertyValue: cannot handle this id!" );
+            }
+        }
+        catch( const Exception& )
+        {
+            TOOLS_WARN_EXCEPTION( "extensions.propctrlr", "SubmissionPropertyHandler::setPropertyValue" );
+        }
+    }
+
+
+    Sequence< OUString > SAL_CALL SubmissionPropertyHandler::getActuatingProperties( )
+    {
+        ::osl::MutexGuard aGuard( m_aMutex );
+        if (!m_pHelper)
+            return Sequence< OUString >();
+
+        Sequence<OUString> aReturn { PROPERTY_XFORMS_BUTTONTYPE };
+        return aReturn;
+    }
+
+
+    Sequence< OUString > SAL_CALL SubmissionPropertyHandler::getSupersededProperties( )
+    {
+        ::osl::MutexGuard aGuard( m_aMutex );
+        if (!m_pHelper)
+            return Sequence< OUString >();
+
+        Sequence< OUString > aReturn{ PROPERTY_TARGET_URL,
+                                      PROPERTY_TARGET_FRAME,
+                                      PROPERTY_BUTTONTYPE };
+        return aReturn;
+    }
+
+
+    void SubmissionPropertyHandler::onNewComponent()
+    {
+        if ( m_xPropChangeMultiplexer.is() )
+        {
+            m_xPropChangeMultiplexer->dispose();
+            m_xPropChangeMultiplexer.clear();
+        }
+
+        PropertyHandlerComponent::onNewComponent();
+
+        Reference< frame::XModel > xDocument( impl_getContextDocument_nothrow() );
+        DBG_ASSERT( xDocument.is(), "SubmissionPropertyHandler::onNewComponent: no document!" );
+
+        m_pHelper.reset();
+
+        if ( SubmissionHelper::canTriggerSubmissions( m_xComponent, xDocument ) )
+        {
+            m_pHelper.reset( new SubmissionHelper( m_aMutex, m_xComponent, xDocument ) );
+
+            m_xPropChangeMultiplexer = new OPropertyChangeMultiplexer( this, m_xComponent );
+            m_xPropChangeMultiplexer->addProperty( PROPERTY_BUTTONTYPE );
+        }
+    }
+
+
+    Sequence< Property > SubmissionPropertyHandler::doDescribeSupportedProperties() const
+    {
+        std::vector< Property > aProperties;
+        if (m_pHelper)
+        {
+            implAddPropertyDescription( aProperties, PROPERTY_SUBMISSION_ID, cppu::UnoType<submission::XSubmission>::get() );
+            implAddPropertyDescription( aProperties, PROPERTY_XFORMS_BUTTONTYPE, ::cppu::UnoType<FormButtonType>::get() );
+        }
+        if ( aProperties.empty() )
+            return Sequence< Property >();
+        return comphelper::containerToSequence(aProperties);
+    }
+
+
+    LineDescriptor SAL_CALL SubmissionPropertyHandler::describePropertyLine( const OUString& _rPropertyName,
+        const Reference< XPropertyControlFactory >& _rxControlFactory )
+    {
+        ::osl::MutexGuard aGuard( m_aMutex );
+        if ( !_rxControlFactory.is() )
+            throw NullPointerException();
+        if (!m_pHelper)
+            throw RuntimeException();
+
+        std::vector< OUString > aListEntries;
+        PropertyId nPropId( impl_getPropertyId_throwUnknownProperty( _rPropertyName ) );
+        switch ( nPropId )
+        {
+        case PROPERTY_ID_SUBMISSION_ID:
+            m_pHelper->getAllElementUINames(EFormsHelper::Submission, aListEntries, false);
+            break;
+
+        case PROPERTY_ID_XFORMS_BUTTONTYPE:
+        {
+            // available options are nearly the same as for the "normal" button type, but only the
+            // first two options
+            aListEntries = m_pInfoService->getPropertyEnumRepresentations( PROPERTY_ID_BUTTONTYPE );
+            aListEntries.resize( 2 );
+        }
+        break;
+
+        default:
+            OSL_FAIL( "SubmissionPropertyHandler::describePropertyLine: cannot handle this id!" );
+            return LineDescriptor();
+        }
+
+        LineDescriptor aDescriptor;
+        aDescriptor.Control = PropertyHandlerHelper::createListBoxControl( _rxControlFactory, std::move(aListEntries), false, true );
+        aDescriptor.DisplayName = m_pInfoService->getPropertyTranslation( nPropId );
+        aDescriptor.Category = "General";
+        aDescriptor.HelpURL = HelpIdUrl::getHelpURL( m_pInfoService->getPropertyHelpId( nPropId ) );
+        return aDescriptor;
+    }
+
+
+    void SAL_CALL SubmissionPropertyHandler::actuatingPropertyChanged( const OUString& _rActuatingPropertyName, const Any& _rNewValue, const Any& /*_rOldValue*/, const Reference< XObjectInspectorUI >& _rxInspectorUI, sal_Bool )
+    {
+        if ( !_rxInspectorUI.is() )
+            throw NullPointerException();
+
+        ::osl::MutexGuard aGuard( m_aMutex );
+        PropertyId nActuatingPropId( impl_getPropertyId_throwRuntime( _rActuatingPropertyName ) );
+        OSL_PRECOND(m_pHelper,
+                    "SubmissionPropertyHandler::actuatingPropertyChanged: inconsistency!");
+        // if we survived impl_getPropertyId_throwRuntime, we should have a helper, since no helper implies no properties
+
+        switch ( nActuatingPropId )
+        {
+        case PROPERTY_ID_XFORMS_BUTTONTYPE:
+        {
+            FormButtonType eType = FormButtonType_PUSH;
+            OSL_VERIFY( _rNewValue >>= eType );
+            _rxInspectorUI->enablePropertyUI( PROPERTY_SUBMISSION_ID, eType == FormButtonType_SUBMIT );
+        }
+        break;
+
+        default:
+            OSL_FAIL( "SubmissionPropertyHandler::actuatingPropertyChanged: cannot handle this id!" );
+        }
+    }
+
+
+    Any SAL_CALL SubmissionPropertyHandler::convertToPropertyValue( const OUString& _rPropertyName, const Any& _rControlValue )
+    {
+        ::osl::MutexGuard aGuard( m_aMutex );
+        Any aPropertyValue;
+
+        OSL_ENSURE(
+            m_pHelper,
+            "SubmissionPropertyHandler::convertToPropertyValue: we have no SupportedProperties!");
+        if (!m_pHelper)
+            return aPropertyValue;
+
+        OUString sControlValue;
+        OSL_VERIFY( _rControlValue >>= sControlValue );
+
+        PropertyId nPropId( m_pInfoService->getPropertyId( _rPropertyName ) );
+        switch ( nPropId )
+        {
+        case PROPERTY_ID_SUBMISSION_ID:
+        {
+            Reference< XSubmission > xSubmission( m_pHelper->getModelElementFromUIName( EFormsHelper::Submission, sControlValue ), UNO_QUERY );
+            aPropertyValue <<= xSubmission;
+        }
+        break;
+
+        case PROPERTY_ID_XFORMS_BUTTONTYPE:
+        {
+            ::rtl::Reference< IPropertyEnumRepresentation > aEnumConversion(
+                new DefaultEnumRepresentation( *m_pInfoService, ::cppu::UnoType<FormButtonType>::get(), PROPERTY_ID_BUTTONTYPE ) );
+            // TODO/UNOize: make aEnumConversion a member?
+            aEnumConversion->getValueFromDescription( sControlValue, aPropertyValue );
+        }
+        break;
+
+        default:
+            OSL_FAIL( "SubmissionPropertyHandler::convertToPropertyValue: cannot handle this id!" );
+        }
+
+        return aPropertyValue;
+    }
+
+
+    Any SAL_CALL SubmissionPropertyHandler::convertToControlValue( const OUString& _rPropertyName, const Any& _rPropertyValue, const Type& _rControlValueType )
+    {
+        ::osl::MutexGuard aGuard( m_aMutex );
+        Any aControlValue;
+
+        OSL_ENSURE(
+            m_pHelper,
+            "SubmissionPropertyHandler::convertToControlValue: we have no SupportedProperties!");
+        if (!m_pHelper)
+            return aControlValue;
+
+        OSL_ENSURE( _rControlValueType.getTypeClass() == TypeClass_STRING,
+            "SubmissionPropertyHandler::convertToControlValue: all our controls should use strings for value exchange!" );
+
+        PropertyId nPropId( m_pInfoService->getPropertyId( _rPropertyName ) );
+        switch ( nPropId )
+        {
+        case PROPERTY_ID_SUBMISSION_ID:
+        {
+            Reference< XPropertySet > xSubmission( _rPropertyValue, UNO_QUERY );
+            if ( xSubmission.is() )
+                aControlValue <<= EFormsHelper::getModelElementUIName( EFormsHelper::Submission, xSubmission );
+        }
+        break;
+
+        case PROPERTY_ID_XFORMS_BUTTONTYPE:
+        {
+            ::rtl::Reference< IPropertyEnumRepresentation > aEnumConversion(
+                new DefaultEnumRepresentation( *m_pInfoService, _rPropertyValue.getValueType(), PROPERTY_ID_BUTTONTYPE ) );
+            // TODO/UNOize: make aEnumConversion a member?
+            aControlValue <<= aEnumConversion->getDescriptionForValue( _rPropertyValue );
+        }
+        break;
+
+        default:
+            OSL_FAIL( "SubmissionPropertyHandler::convertToControlValue: cannot handle this id!" );
+        }
+
+        return aControlValue;
+    }
+
+
+    void SubmissionPropertyHandler::_propertyChanged( const PropertyChangeEvent& _rEvent )
+    {
+        if ( _rEvent.PropertyName == PROPERTY_BUTTONTYPE )
+            firePropertyChange( PROPERTY_XFORMS_BUTTONTYPE, PROPERTY_ID_XFORMS_BUTTONTYPE, _rEvent.OldValue, _rEvent.NewValue );
+    }
+
+
+} // namespace pcr
+
+extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
+extensions_propctrlr_SubmissionPropertyHandler_get_implementation(
+    css::uno::XComponentContext* context , css::uno::Sequence<css::uno::Any> const&)
+{
+    return cppu::acquire(new pcr::SubmissionPropertyHandler(context));
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */