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, 241 insertions, 0 deletions

diff --git a/extensions/source/propctrlr/eventhandler.hxx b/extensions/source/propctrlr/eventhandler.hxx
new file mode 100644
index 000000000..4506f1b06
--- /dev/null
+++ b/extensions/source/propctrlr/eventhandler.hxx
@@ -0,0 +1,241 @@
+/* -*- 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 .
+ */
+
+#pragma once
+
+#include "pcrcommon.hxx"
+
+#include <com/sun/star/script/ScriptEventDescriptor.hpp>
+#include <com/sun/star/lang/XServiceInfo.hpp>
+#include <com/sun/star/inspection/XPropertyHandler.hpp>
+#include <com/sun/star/beans/XPropertySet.hpp>
+#include <com/sun/star/frame/XFrame.hpp>
+#include <com/sun/star/uno/XComponentContext.hpp>
+#include <cppuhelper/compbase.hxx>
+#include <unotools/resmgr.hxx>
+
+#include <unordered_map>
+
+namespace pcr
+{
+
+
+    //= EventDescription
+
+    typedef sal_Int32   EventId;
+    struct EventDescription
+    {
+    public:
+        OUString sDisplayName;
+        OUString sListenerClassName;
+        OUString sListenerMethodName;
+        OUString sHelpId;
+        OString  sUniqueBrowseId;
+        EventId         nId;
+
+        EventDescription()
+            :nId( 0 )
+            {
+            }
+
+        EventDescription(
+            EventId _nId,
+            const char* _pListenerNamespaceAscii,
+            const char* _pListenerClassAsciiName,
+            const char* _pListenerMethodAsciiName,
+            TranslateId pDisplayNameResId,
+            const OUString& _sHelpId,
+            const OString& _sUniqueBrowseId );
+    };
+
+    typedef std::unordered_map< OUString, EventDescription >   EventMap;
+
+
+    //= EventHandler
+
+    typedef ::cppu::WeakComponentImplHelper    <   css::inspection::XPropertyHandler
+                                                ,   css::lang::XServiceInfo
+                                                >   EventHandler_Base;
+    class EventHandler final : public EventHandler_Base
+    {
+    private:
+        mutable ::osl::Mutex    m_aMutex;
+
+        /// the context in which the instance was created
+        css::uno::Reference< css::uno::XComponentContext >  m_xContext;
+        /// the properties of the object we're handling
+        css::uno::Reference< css::beans::XPropertySet >     m_xComponent;
+        /// our XPropertyChangeListener(s)
+        PropertyChangeListeners                             m_aPropertyListeners;
+        /// cache of the events we found at our introspectee
+        EventMap                                            m_aEvents;
+        /// has m_aEvents been initialized?
+        bool                                                m_bEventsMapInitialized;
+        /// is our introspectee a dialog element?
+        bool                                                m_bIsDialogElement;
+            // TODO: move different handling into different derived classes?
+        /// (FormComponent) type of the grid column being inspected, or -1 if we're not inspecting a grid column
+        sal_Int16                                           m_nGridColumnType;
+
+    public:
+        explicit EventHandler(
+            const css::uno::Reference< css::uno::XComponentContext >& _rxContext
+       );
+
+        virtual ~EventHandler() override;
+
+    private:
+        // XPropertyHandler overridables
+        virtual void                                         SAL_CALL inspect( const css::uno::Reference< css::uno::XInterface >& _rxIntrospectee ) override;
+        virtual css::uno::Any                                SAL_CALL getPropertyValue( const OUString& _rPropertyName ) override;
+        virtual void                                         SAL_CALL setPropertyValue( const OUString& _rPropertyName, const css::uno::Any& _rValue ) override;
+        virtual css::uno::Any                                SAL_CALL convertToPropertyValue( const OUString& _rPropertyName, const css::uno::Any& _rControlValue ) override;
+        virtual css::uno::Any                                SAL_CALL convertToControlValue( const OUString& _rPropertyName, const css::uno::Any& _rPropertyValue, const css::uno::Type& _rControlValueType ) override;
+        virtual css::beans::PropertyState                    SAL_CALL getPropertyState( const OUString& _rPropertyName ) override;
+        virtual void                                         SAL_CALL addPropertyChangeListener( const css::uno::Reference< css::beans::XPropertyChangeListener >& _rxListener ) override;
+        virtual void                                         SAL_CALL removePropertyChangeListener( const css::uno::Reference< css::beans::XPropertyChangeListener >& _rxListener ) override;
+        virtual css::uno::Sequence< css::beans::Property >   SAL_CALL getSupportedProperties() override;
+        virtual css::uno::Sequence< OUString >               SAL_CALL getSupersededProperties( ) override;
+        virtual css::uno::Sequence< OUString >               SAL_CALL getActuatingProperties( ) override;
+        virtual css::inspection::LineDescriptor              SAL_CALL describePropertyLine( const OUString& _rPropertyName, const css::uno::Reference< css::inspection::XPropertyControlFactory >& _rxControlFactory ) override;
+        virtual sal_Bool                                     SAL_CALL isComposable( const OUString& _rPropertyName ) override;
+        virtual css::inspection::InteractiveSelectionResult  SAL_CALL onInteractivePropertySelection( const OUString& _rPropertyName, sal_Bool _bPrimary, css::uno::Any& _rData, const css::uno::Reference< css::inspection::XObjectInspectorUI >& _rxInspectorUI ) override;
+        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;
+        virtual sal_Bool                                     SAL_CALL suspend( sal_Bool _bSuspend ) override;
+
+        // XComponent
+        DECLARE_XCOMPONENT()
+        virtual void                                         SAL_CALL disposing() override;
+
+        // XServiceInfo
+        virtual OUString SAL_CALL getImplementationName(  ) override;
+        virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
+        virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames(  ) override;
+
+        /** returns the script events associated with our introspectee
+            @param  _out_rEvents
+                Takes, upon successful return, the events currently associated with the introspectee
+            @precond
+                Our introspectee is a form component
+        */
+        void    impl_getFormComponentScriptEvents_nothrow(
+                    std::vector< css::script::ScriptEventDescriptor >& _out_rEvents
+                ) const;
+
+        /** returns the script events associated with our introspectee
+            @param  _out_rEvents
+                Takes, upon successful return, the events currently associated with the introspectee
+            @precond
+                Our introspectee is a dialog element
+        */
+        void    impl_getDialogElementScriptEvents_nothrow(
+                    std::vector< css::script::ScriptEventDescriptor >& _out_rEvents
+                ) const;
+
+        /** returns the script events associated with our introspectee
+            @param  _out_rEvents
+                Takes, the events currently associated with the introspectee
+        */
+        void impl_getComponentScriptEvents_nothrow(
+                    std::vector< css::script::ScriptEventDescriptor >& _out_rEvents
+                ) const
+        {
+            if ( m_bIsDialogElement )
+                impl_getDialogElementScriptEvents_nothrow( _out_rEvents );
+            else
+                impl_getFormComponentScriptEvents_nothrow( _out_rEvents );
+        }
+
+        /** returns the types of the listeners which can be registered at our introspectee
+            @param  _out_rTypes
+                Takes, upon successful return, the types of possible listeners at the introspectee
+        */
+        void    impl_getComponentListenerTypes_nothrow(
+                    std::vector< css::uno::Type >& _out_rTypes
+                ) const;
+
+        /** returns a secondary component to be used for event inspection
+
+            In the UI, we want to mix events for the control model with events for the control.
+            Since our introspectee is a model, this method creates a control for it (if possible).
+
+            @return
+                the secondary component whose events should be mixed with the introspectee's events
+                The caller takes the ownership of the component (if not <NULL/>).
+
+            @throws
+                if an unexpected error occurs during creation of the secondary component.
+                A <NULL/> component to be returned is not unexpected, but allowed
+
+            @precond
+                ->m_xComponent is not <NULL/>
+        */
+        css::uno::Reference< css::uno::XInterface >
+                impl_getSecondaryComponentForEventInspection_throw( ) const;
+
+        /** returns the event description for the given (programmatic) property name
+            @param  _rPropertyName
+                the name whose event description should be looked up
+            @return
+                the event description for the property name
+            @throws css::beans::UnknownPropertyException
+                if our introspectee does not have an event with the given logical name (see ->getSupportedProperties)
+        */
+        const EventDescription&
+                impl_getEventForName_throw( const OUString& _rPropertyName ) const;
+
+        /** returns the index of our component within its parent, if this parent can be
+            obtained  (XChild::getParent) and supports an ->XIndexAccess interface
+        */
+        sal_Int32   impl_getComponentIndexInParent_throw() const;
+
+        /** sets a given script event as event handler at a form component
+
+            @param  _rScriptEvent
+                the script event to set
+        */
+        void    impl_setFormComponentScriptEvent_nothrow( const css::script::ScriptEventDescriptor& _rScriptEvent );
+
+        /** sets a given script event as event handler at a dialog component
+
+            @param  _rScriptEvent
+                the script event to set
+        */
+        void    impl_setDialogElementScriptEvent_nothrow( const css::script::ScriptEventDescriptor& _rScriptEvent );
+
+        /** returns the frame associated with our context document
+        */
+        css::uno::Reference< css::frame::XFrame >
+                impl_getContextFrame_nothrow() const;
+
+        /** approves or denies a certain method to be included in the UI
+            @return
+                <TRUE/> if and only if the given method is allowed.
+        */
+        bool    impl_filterMethod_nothrow( const EventDescription& _rEvent ) const;
+
+        EventHandler( const EventHandler& ) = delete;
+        EventHandler& operator=( const EventHandler& ) = delete;
+    };
+
+
+} // namespace pcr
+
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */