INTEGRATION: CWS eforms2 (1.1.2); FILE ADDED

2004/11/05 17:49:05 fs 1.1.2.2: #i36765# allow external instances to provide an InteractionHandler (via DispatchProviderInterception), which is used upon submission via UI
2004/07/12 14:16:22 fs 1.1.2.1: base class for controls which are clickable, and contain an image (formerly known as OImage* in Image.*)

1 files changed, 328 insertions, 0 deletions

diff --git a/forms/source/component/clickableimage.hxx b/forms/source/component/clickableimage.hxx
new file mode 100644
index 000000000000..cceb902b34c0
--- /dev/null
+++ b/forms/source/component/clickableimage.hxx
@@ -0,0 +1,328 @@
+/*************************************************************************
+ *
+ *  $RCSfile: clickableimage.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: obo $ $Date: 2004-11-16 10:41:41 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef FORMS_SOURCE_CLICKABLEIMAGE_HXX
+#define FORMS_SOURCE_CLICKABLEIMAGE_HXX
+
+#ifndef _FORMS_FORMCOMPONENT_HXX_
+#include "FormComponent.hxx"
+#endif
+
+#ifndef _FRM_EVENT_THREAD_HXX_
+#include "EventThread.hxx"
+#endif
+
+#ifndef _LINK_HXX
+#include <tools/link.hxx>
+#endif
+#ifndef _COMPHELPER_PROPERTY_MULTIPLEX_HXX_
+#include <comphelper/propmultiplex.hxx>
+#endif
+#ifndef _PRODUCE_HXX
+#include <svtools/imgprod.hxx>
+#endif
+
+#ifndef _COM_SUN_STAR_FORM_XIMAGEPRODUCERSUPPLIER_HPP_
+#include <com/sun/star/form/XImageProducerSupplier.hpp>
+#endif
+#ifndef _COM_SUN_STAR_FORM_FORMBUTTONTYPE_HPP_
+#include <com/sun/star/form/FormButtonType.hpp>
+#endif
+#ifndef _COM_SUN_STAR_FORM_XAPPROVEACTIONLISTENER_HPP_
+#include <com/sun/star/form/XApproveActionListener.hpp>
+#endif
+#ifndef _COM_SUN_STAR_FORM_XAPPROVEACTIONBROADCASTER_HPP_
+#include <com/sun/star/form/XApproveActionBroadcaster.hpp>
+#endif
+#ifndef _COM_SUN_STAR_FORM_SUBMISSION_XSUBMISSIONSUPPLIER_HPP_
+#include <com/sun/star/form/submission/XSubmissionSupplier.hpp>
+#endif
+#ifndef _COM_SUN_STAR_FORM_SUBMISSION_XSUBMISSION_HPP_
+#include <com/sun/star/form/submission/XSubmission.hpp>
+#endif
+#ifndef _COM_SUN_STAR_FRAME_XMODEL_HPP_
+#include <com/sun/star/frame/XModel.hpp>
+#endif
+#ifndef _COM_SUN_STAR_FRAME_XDISPATCHPROVIDERINTERCEPTION_HPP_
+#include <com/sun/star/frame/XDispatchProviderInterception.hpp>
+#endif
+
+#ifndef _CPPUHELPER_IMPLBASE3_HXX_
+#include <cppuhelper/implbase3.hxx>
+#endif
+
+
+class SfxMedium;
+
+//.........................................................................
+namespace frm
+{
+//.........................................................................
+
+    class SubmissionVetoListeners;
+    class ControlFeatureInterception;
+    //==================================================================
+    // OClickableImageBaseModel
+    //==================================================================
+    typedef ::cppu::ImplHelper3 <   ::com::sun::star::form::XImageProducerSupplier
+                                ,   ::com::sun::star::awt::XImageProducer
+                                ,   ::com::sun::star::form::submission::XSubmissionSupplier
+                                >   OClickableImageBaseModel_Base;
+
+    class OClickableImageBaseModel  :public OClickableImageBaseModel_Base
+                                    ,public OControlModel
+                                    ,public OPropertyChangeListener
+    {
+    protected:
+        ::com::sun::star::form::FormButtonType  m_eButtonType;      // Art des Buttons (push,submit,reset)
+        ::rtl::OUString                         m_sTargetURL;       // URL fuer den URL-Button
+        ::rtl::OUString                         m_sTargetFrame;     // TargetFrame zum Oeffnen
+
+        // ImageProducer stuff
+        ::com::sun::star::uno::Reference< ::com::sun::star::awt::XImageProducer>    m_xProducer;
+        SfxMedium*                              m_pMedium;          // Download-Medium
+        ImageProducer*                          m_pProducer;
+        sal_Bool                                m_bDispatchUrlInternal; // property: is not allowed to set : 1
+        sal_Bool                                m_bDownloading : 1; // laeuft ein Download?
+        sal_Bool                                m_bProdStarted : 1;
+
+        // XSubmission stuff
+        ::com::sun::star::uno::Reference< ::com::sun::star::form::submission::XSubmission >
+                                                m_xSubmissionDelegate;
+
+
+        DECL_STATIC_LINK( OClickableImageBaseModel, DataAvailableLink, void* );
+        DECL_STATIC_LINK( OClickableImageBaseModel, DownloadDoneLink, void* );
+
+        inline ImageProducer* GetImageProducer() { return m_pProducer; }
+
+        void StartProduction();
+        void SetURL(const ::rtl::OUString& rURL);
+        void DataAvailable();
+        void DownloadDone();
+
+        ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type> _getTypes();
+        inline sal_Bool isDispatchUrlInternal() const { return m_bDispatchUrlInternal; }
+        inline void     setDispatchUrlInternal(sal_Bool _bDispatch) { m_bDispatchUrlInternal = _bDispatch; }
+
+    public:
+        DECLARE_DEFAULT_XTOR( OClickableImageBaseModel );
+
+        // UNO Anbindung
+        DECLARE_UNO3_AGG_DEFAULTS(OClickableImageBaseModel, OControlModel);
+        virtual ::com::sun::star::uno::Any SAL_CALL queryAggregation(const ::com::sun::star::uno::Type& _rType) throw(::com::sun::star::uno::RuntimeException);
+
+    protected:
+    // OComponentHelper
+        virtual void SAL_CALL disposing();
+
+    // ::com::sun::star::form::XImageProducerSupplier
+        virtual ::com::sun::star::uno::Reference< ::com::sun::star::awt::XImageProducer> SAL_CALL getImageProducer() throw (::com::sun::star::uno::RuntimeException) { return m_xProducer; }
+
+    // OPropertySetHelper
+        virtual void SAL_CALL getFastPropertyValue(::com::sun::star::uno::Any& rValue, sal_Int32 nHandle ) const;
+        virtual void SAL_CALL setFastPropertyValue_NoBroadcast(sal_Int32 nHandle, const ::com::sun::star::uno::Any& rValue) throw (::com::sun::star::uno::Exception);
+
+        virtual sal_Bool SAL_CALL convertFastPropertyValue(::com::sun::star::uno::Any& rConvertedValue, ::com::sun::star::uno::Any& rOldValue, sal_Int32 nHandle, const ::com::sun::star::uno::Any& rValue )
+            throw(::com::sun::star::lang::IllegalArgumentException);
+
+    // OPropertyChangeListener
+        virtual void _propertyChanged(const ::com::sun::star::beans::PropertyChangeEvent&) throw(::com::sun::star::uno::RuntimeException);
+
+    // ::com::sun::star::beans::XPropertyState
+        virtual ::com::sun::star::beans::PropertyState getPropertyStateByHandle(sal_Int32 nHandle);
+        virtual void setPropertyToDefaultByHandle(sal_Int32 nHandle);
+        virtual ::com::sun::star::uno::Any getPropertyDefaultByHandle( sal_Int32 nHandle ) const;
+
+    // XImageProducer
+        virtual void SAL_CALL addConsumer( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XImageConsumer >& xConsumer ) throw (::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL removeConsumer( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XImageConsumer >& xConsumer ) throw (::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL startProduction(  ) throw (::com::sun::star::uno::RuntimeException);
+
+        // XSubmissionSupplier
+        virtual ::com::sun::star::uno::Reference< ::com::sun::star::form::submission::XSubmission > SAL_CALL getSubmission() throw (::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL setSubmission( const ::com::sun::star::uno::Reference< ::com::sun::star::form::submission::XSubmission >& _submission ) throw (::com::sun::star::uno::RuntimeException);
+
+        // XServiceInfo
+        virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames(  ) throw (::com::sun::star::uno::RuntimeException);
+
+    protected:
+        void implConstruct();
+
+        // to be called from within the cloning-ctor of your derived class
+        void implInitializeImageURL( );
+    };
+
+    //==================================================================
+    // OClickableImageBaseControl
+    //==================================================================
+    typedef ::cppu::ImplHelper3 <   ::com::sun::star::form::XApproveActionBroadcaster
+                                ,   ::com::sun::star::form::submission::XSubmission
+                                ,   ::com::sun::star::frame::XDispatchProviderInterception
+                                >   OClickableImageBaseControl_BASE;
+
+    class OClickableImageBaseControl    :public OClickableImageBaseControl_BASE
+                                        ,public OControl
+    {
+        friend class OImageProducerThread_Impl;
+
+    private:
+        OImageProducerThread_Impl*  m_pThread;
+        ::std::auto_ptr< SubmissionVetoListeners >
+                                    m_pSubmissionVetoListeners;
+        ::std::auto_ptr< ControlFeatureInterception >
+                                    m_pFeatureInterception;
+
+    protected:
+        ::cppu::OInterfaceContainerHelper m_aApproveActionListeners;
+        ::cppu::OInterfaceContainerHelper m_aActionListeners;
+        ::rtl::OUString m_aActionCommand;
+
+        // XSubmission
+        virtual void SAL_CALL submit(  ) throw (::com::sun::star::util::VetoException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL submitWithInteraction( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& aHandler ) throw (::com::sun::star::util::VetoException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL addSubmissionVetoListener( const ::com::sun::star::uno::Reference< ::com::sun::star::form::submission::XSubmissionVetoListener >& listener ) throw (::com::sun::star::lang::NoSupportException, ::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL removeSubmissionVetoListener( const ::com::sun::star::uno::Reference< ::com::sun::star::form::submission::XSubmissionVetoListener >& listener ) throw (::com::sun::star::lang::NoSupportException, ::com::sun::star::uno::RuntimeException);
+
+        // XServiceInfo
+        virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames(  ) throw (::com::sun::star::uno::RuntimeException);
+
+    public:
+        OClickableImageBaseControl(
+            const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory>& _rxFactory,
+            const ::rtl::OUString& _aService);
+        virtual ~OClickableImageBaseControl();
+
+    protected:
+        // UNO Anbindung
+        DECLARE_UNO3_AGG_DEFAULTS(OClickableImageBaseControl, OControl);
+        virtual ::com::sun::star::uno::Any SAL_CALL queryAggregation(const ::com::sun::star::uno::Type& _rType) throw(::com::sun::star::uno::RuntimeException);
+
+        // OComponentHelper
+        virtual void SAL_CALL disposing();
+
+        // ::com::sun::star::form::XApproveActionBroadcaster
+        virtual void SAL_CALL addApproveActionListener(const ::com::sun::star::uno::Reference< ::com::sun::star::form::XApproveActionListener>& _rxListener)
+            throw(::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL removeApproveActionListener(const ::com::sun::star::uno::Reference< ::com::sun::star::form::XApproveActionListener>& _rxListener)
+            throw(::com::sun::star::uno::RuntimeException);
+
+        // XDispatchProviderInterception
+        virtual void SAL_CALL registerDispatchProviderInterceptor( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XDispatchProviderInterceptor >& Interceptor ) throw (::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL releaseDispatchProviderInterceptor( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XDispatchProviderInterceptor >& Interceptor ) throw (::com::sun::star::uno::RuntimeException);
+
+    protected:
+        ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >  getXModel(const InterfaceRef& xIface) const;
+
+        virtual void actionPerformed_Impl( sal_Bool bNotifyListener, const ::com::sun::star::awt::MouseEvent& rEvt );
+
+        ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > _getTypes();
+
+        /** approves the action by calling the approve listeners
+            @return <TRUE/> if and only if the action has <em>not</em> been cancelled by a listener
+        */
+        bool    approveAction( );
+
+        /** retrieves (and if necessary creates) the image producer thread.
+
+            Must be called with our mutex locked
+        */
+        OImageProducerThread_Impl* getImageProducerThread();
+
+    private:
+        void implSubmit(
+            const ::com::sun::star::awt::MouseEvent& _rEvent,
+            const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& aHandler
+        ) SAL_THROW((com::sun::star::util::VetoException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException));
+    };
+
+    //==================================================================
+    // OImageProducerThread_Impl
+    //==================================================================
+    class OImageProducerThread_Impl: public OComponentEventThread
+    {
+    protected:
+
+        // Die folgende Methode wrrd gerufen um das Event unter Beruecksichtigung
+        // seines Typs zu duplizieren
+        virtual ::com::sun::star::lang::EventObject* cloneEvent( const ::com::sun::star::lang::EventObject* _pEvt ) const;
+
+        // Ein Event bearbeiten. Der Mutex ist dabei nicht gelockt, pCompImpl
+        // bleibt aber in jedem Fall gueltig.
+        virtual void processEvent( ::cppu::OComponentHelper *pCompImpl,
+                                const ::com::sun::star::lang::EventObject*,
+                                const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControl>&,
+                                sal_Bool );
+
+    public:
+        OImageProducerThread_Impl( OClickableImageBaseControl *pControl ) :
+            OComponentEventThread( pControl )
+        {}
+
+        void addEvent() { ::com::sun::star::lang::EventObject aEvt; OComponentEventThread::addEvent( &aEvt ); }
+    };
+
+//.........................................................................
+}   // namespace frm
+//.........................................................................
+
+#endif // FORMS_SOURCE_CLICKABLEIMAGE_HXX
+