forms/source/component/clickableimage.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: clickableimage.hxx,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef FORMS_SOURCE_CLICKABLEIMAGE_HXX
  32 #define FORMS_SOURCE_CLICKABLEIMAGE_HXX
  33
  34 #include "FormComponent.hxx"
  35 #include "EventThread.hxx"
  36 #include "imgprod.hxx"
  37 #include <tools/link.hxx>
  38 #include <comphelper/propmultiplex.hxx>
  39 #include <com/sun/star/form/XImageProducerSupplier.hpp>
  40 #include <com/sun/star/form/FormButtonType.hpp>
  41 #include <com/sun/star/form/XApproveActionListener.hpp>
  42 #include <com/sun/star/form/XApproveActionBroadcaster.hpp>
  43 #include <com/sun/star/form/submission/XSubmissionSupplier.hpp>
  44 #include <com/sun/star/form/submission/XSubmission.hpp>
  45 #include <com/sun/star/frame/XModel.hpp>
  46 #include <com/sun/star/frame/XDispatchProviderInterception.hpp>
  47 #include <cppuhelper/implbase3.hxx>
  48
  49
  50 class SfxMedium;
  51
  52 //.........................................................................
  53 namespace frm
  54 {
  55 //.........................................................................
  56
  57     class OImageProducerThread_Impl;
  58     class ControlFeatureInterception;
  59     //==================================================================
  60     // OClickableImageBaseModel
  61     //==================================================================
  62     typedef ::cppu::ImplHelper3 <   ::com::sun::star::form::XImageProducerSupplier
  63                                 ,   ::com::sun::star::awt::XImageProducer
  64                                 ,   ::com::sun::star::form::submission::XSubmissionSupplier
  65                                 >   OClickableImageBaseModel_Base;
  66
  67     class OClickableImageBaseModel  :public OClickableImageBaseModel_Base
  68                                     ,public OControlModel
  69                                     ,public OPropertyChangeListener
  70     {
  71     protected:
  72         ::com::sun::star::form::FormButtonType  m_eButtonType;          // Art des Buttons (push,submit,reset)
  73         ::rtl::OUString                                                 m_sTargetURL;           // URL fuer den URL-Button
  74         ::rtl::OUString                                                 m_sTargetFrame;         // TargetFrame zum Oeffnen
  75
  76         // ImageProducer stuff
  77         ::com::sun::star::uno::Reference< ::com::sun::star::awt::XImageProducer>        m_xProducer;
  78         SfxMedium*                                                              m_pMedium;                      // Download-Medium
  79         ImageProducer*                                                  m_pProducer;
  80         sal_Bool                                                                m_bDispatchUrlInternal; // property: is not allowed to set : 1
  81         sal_Bool                                                                m_bDownloading : 1;     // laeuft ein Download?
  82         sal_Bool                                                                m_bProdStarted : 1;
  83
  84         // XSubmission stuff
  85         ::com::sun::star::uno::Reference< ::com::sun::star::form::submission::XSubmission >
  86                                                 m_xSubmissionDelegate;
  87
  88
  89         DECL_STATIC_LINK( OClickableImageBaseModel, DataAvailableLink, void* );
  90         DECL_STATIC_LINK( OClickableImageBaseModel, DownloadDoneLink, void* );
  91
  92         inline ImageProducer* GetImageProducer() { return m_pProducer; }
  93
  94         void StartProduction();
  95         void SetURL(const ::rtl::OUString& rURL);
  96         void DataAvailable();
  97         void DownloadDone();
  98
  99         ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type> _getTypes();
 100         inline sal_Bool isDispatchUrlInternal() const { return m_bDispatchUrlInternal; }
 101         inline void             setDispatchUrlInternal(sal_Bool _bDispatch) { m_bDispatchUrlInternal = _bDispatch; }
 102
 103     public:
 104         DECLARE_DEFAULT_XTOR( OClickableImageBaseModel );
 105
 106         // UNO Anbindung
 107         DECLARE_UNO3_AGG_DEFAULTS(OClickableImageBaseModel, OControlModel);
 108         virtual ::com::sun::star::uno::Any SAL_CALL queryAggregation(const ::com::sun::star::uno::Type& _rType) throw(::com::sun::star::uno::RuntimeException);
 109
 110     protected:
 111         // OComponentHelper
 112         virtual void SAL_CALL disposing();
 113
 114         // ::com::sun::star::form::XImageProducerSupplier
 115         virtual ::com::sun::star::uno::Reference< ::com::sun::star::awt::XImageProducer> SAL_CALL getImageProducer() throw (::com::sun::star::uno::RuntimeException) { return m_xProducer; }
 116
 117         // OPropertySetHelper
 118         virtual void SAL_CALL getFastPropertyValue(::com::sun::star::uno::Any& rValue, sal_Int32 nHandle ) const;
 119         virtual void SAL_CALL setFastPropertyValue_NoBroadcast(sal_Int32 nHandle, const ::com::sun::star::uno::Any& rValue) throw (::com::sun::star::uno::Exception);
 120
 121         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 )
 122             throw(::com::sun::star::lang::IllegalArgumentException);
 123
 124         using ::cppu::OPropertySetHelper::getFastPropertyValue;
 125
 126         // OPropertyChangeListener
 127         virtual void _propertyChanged(const ::com::sun::star::beans::PropertyChangeEvent&) throw(::com::sun::star::uno::RuntimeException);
 128
 129         // XPropertyState
 130         virtual ::com::sun::star::uno::Any getPropertyDefaultByHandle( sal_Int32 nHandle ) const;
 131
 132         // XImageProducer
 133         virtual void SAL_CALL addConsumer( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XImageConsumer >& xConsumer ) throw (::com::sun::star::uno::RuntimeException);
 134         virtual void SAL_CALL removeConsumer( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XImageConsumer >& xConsumer ) throw (::com::sun::star::uno::RuntimeException);
 135         virtual void SAL_CALL startProduction(  ) throw (::com::sun::star::uno::RuntimeException);
 136
 137         // XSubmissionSupplier
 138         virtual ::com::sun::star::uno::Reference< ::com::sun::star::form::submission::XSubmission > SAL_CALL getSubmission() throw (::com::sun::star::uno::RuntimeException);
 139         virtual void SAL_CALL setSubmission( const ::com::sun::star::uno::Reference< ::com::sun::star::form::submission::XSubmission >& _submission ) throw (::com::sun::star::uno::RuntimeException);
 140
 141         // XServiceInfo
 142         virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames(  ) throw (::com::sun::star::uno::RuntimeException);
 143
 144         // XEventListener
 145         using OControlModel::disposing;
 146
 147     public:
 148         struct GuardAccess { friend class ImageModelMethodGuard; private: GuardAccess() { } };
 149         ::osl::Mutex&   getMutex( GuardAccess ) { return m_aMutex; }
 150         ImageProducer*  getImageProducer( GuardAccess ) { return m_pProducer; }
 151
 152     protected:
 153         using OControlModel::getMutex;
 154
 155         void implConstruct();
 156
 157         // to be called from within the cloning-ctor of your derived class
 158         void implInitializeImageURL( );
 159     };
 160
 161     //==================================================================
 162     // ImageModelMethodGuard
 163     //==================================================================
 164     class ImageModelMethodGuard : public ::osl::MutexGuard
 165     {
 166     private:
 167         typedef ::osl::MutexGuard   GuardBase;
 168
 169     public:
 170         ImageModelMethodGuard( OClickableImageBaseModel& _rModel )
 171             :GuardBase( _rModel.getMutex( OClickableImageBaseModel::GuardAccess() ) )
 172         {
 173             if ( NULL == _rModel.getImageProducer( OClickableImageBaseModel::GuardAccess() ) )
 174                 throw ::com::sun::star::lang::DisposedException(
 175                     ::rtl::OUString(),
 176                     static_cast< ::com::sun::star::form::XImageProducerSupplier* >( &_rModel )
 177                 );
 178         }
 179     };
 180
 181     //==================================================================
 182     // OClickableImageBaseControl
 183     //==================================================================
 184     typedef ::cppu::ImplHelper3 <   ::com::sun::star::form::XApproveActionBroadcaster
 185                                 ,   ::com::sun::star::form::submission::XSubmission
 186                                 ,   ::com::sun::star::frame::XDispatchProviderInterception
 187                                 >   OClickableImageBaseControl_BASE;
 188
 189     class OClickableImageBaseControl    :public OClickableImageBaseControl_BASE
 190                                         ,public OControl
 191     {
 192         friend class OImageProducerThread_Impl;
 193
 194     private:
 195         OImageProducerThread_Impl*          m_pThread;
 196         ::cppu::OInterfaceContainerHelper   m_aSubmissionVetoListeners;
 197         ::std::auto_ptr< ControlFeatureInterception >
 198                                             m_pFeatureInterception;
 199
 200     protected:
 201         ::cppu::OInterfaceContainerHelper m_aApproveActionListeners;
 202         ::cppu::OInterfaceContainerHelper m_aActionListeners;
 203         ::rtl::OUString m_aActionCommand;
 204
 205         // XSubmission
 206         virtual void SAL_CALL submit(  ) throw (::com::sun::star::util::VetoException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
 207         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);
 208         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);
 209         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);
 210
 211         // XServiceInfo
 212         virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames(  ) throw (::com::sun::star::uno::RuntimeException);
 213
 214         // XEventListener
 215         using OControl::disposing;
 216
 217     public:
 218         OClickableImageBaseControl(
 219             const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory>& _rxFactory,
 220             const ::rtl::OUString& _aService);
 221         virtual ~OClickableImageBaseControl();
 222
 223     protected:
 224         // UNO Anbindung
 225         DECLARE_UNO3_AGG_DEFAULTS(OClickableImageBaseControl, OControl);
 226         virtual ::com::sun::star::uno::Any SAL_CALL queryAggregation(const ::com::sun::star::uno::Type& _rType) throw(::com::sun::star::uno::RuntimeException);
 227
 228         // OComponentHelper
 229         virtual void SAL_CALL disposing();
 230
 231         // ::com::sun::star::form::XApproveActionBroadcaster
 232         virtual void SAL_CALL addApproveActionListener(const ::com::sun::star::uno::Reference< ::com::sun::star::form::XApproveActionListener>& _rxListener)
 233             throw(::com::sun::star::uno::RuntimeException);
 234         virtual void SAL_CALL removeApproveActionListener(const ::com::sun::star::uno::Reference< ::com::sun::star::form::XApproveActionListener>& _rxListener)
 235             throw(::com::sun::star::uno::RuntimeException);
 236
 237         // XDispatchProviderInterception
 238         virtual void SAL_CALL registerDispatchProviderInterceptor( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XDispatchProviderInterceptor >& Interceptor ) throw (::com::sun::star::uno::RuntimeException);
 239         virtual void SAL_CALL releaseDispatchProviderInterceptor( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XDispatchProviderInterceptor >& Interceptor ) throw (::com::sun::star::uno::RuntimeException);
 240
 241     protected:
 242         virtual void actionPerformed_Impl( sal_Bool bNotifyListener, const ::com::sun::star::awt::MouseEvent& rEvt );
 243
 244         ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > _getTypes();
 245
 246         /** approves the action by calling the approve listeners
 247             @return <TRUE/> if and only if the action has <em>not</em> been cancelled by a listener
 248         */
 249         bool    approveAction( );
 250
 251         /** retrieves (and if necessary creates) the image producer thread.
 252
 253             Must be called with our mutex locked
 254         */
 255         OImageProducerThread_Impl* getImageProducerThread();
 256
 257     private:
 258         void implSubmit(
 259             const ::com::sun::star::awt::MouseEvent& _rEvent,
 260             const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& aHandler
 261         ) SAL_THROW((com::sun::star::util::VetoException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException));
 262     };
 263
 264     //==================================================================
 265     // OImageProducerThread_Impl
 266     //==================================================================
 267     class OImageProducerThread_Impl: public OComponentEventThread
 268     {
 269     protected:
 270
 271         // Die folgende Methode wrrd gerufen um das Event unter Beruecksichtigung
 272         // seines Typs zu duplizieren
 273         virtual ::com::sun::star::lang::EventObject* cloneEvent( const ::com::sun::star::lang::EventObject* _pEvt ) const;
 274
 275         // Ein Event bearbeiten. Der Mutex ist dabei nicht gelockt, pCompImpl
 276         // bleibt aber in jedem Fall gueltig.
 277         virtual void processEvent( ::cppu::OComponentHelper *pCompImpl,
 278                                 const ::com::sun::star::lang::EventObject*,
 279                                 const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControl>&,
 280                                 sal_Bool );
 281
 282     public:
 283         OImageProducerThread_Impl( OClickableImageBaseControl *pControl ) :
 284             OComponentEventThread( pControl )
 285         {}
 286
 287         void addEvent() { ::com::sun::star::lang::EventObject aEvt; OComponentEventThread::addEvent( &aEvt ); }
 288
 289     protected:
 290         using OComponentEventThread::addEvent;
 291     };
 292
 293 //.........................................................................
 294 }       // namespace frm
 295 //.........................................................................
 296
 297 #endif // FORMS_SOURCE_CLICKABLEIMAGE_HXX
 298