toolkit/source/controls/animatedimages.cxx

   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
  21 #include <toolkit/controls/animatedimages.hxx>
  22 #include <toolkit/helper/property.hxx>
  23
  24 #include <com/sun/star/lang/DisposedException.hpp>
  25 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  26 #include <com/sun/star/awt/VisualEffect.hpp>
  27 #include <com/sun/star/awt/ImageScaleMode.hpp>
  28 #include <com/sun/star/awt/XAnimation.hpp>
  29 #include <com/sun/star/awt/XAnimatedImages.hpp>
  30 #include <com/sun/star/beans/XPropertySetInfo.hpp>
  31 #include <com/sun/star/container/XContainerListener.hpp>
  32 #include <com/sun/star/uno/XComponentContext.hpp>
  33 #include <com/sun/star/util/XModifyListener.hpp>
  34
  35 #include <toolkit/controls/unocontrolbase.hxx>
  36 #include <toolkit/controls/unocontrolmodel.hxx>
  37
  38 #include <cppuhelper/implbase2.hxx>
  39
  40 #include <helper/unopropertyarrayhelper.hxx>
  41
  42 using namespace css::awt;
  43 using namespace css::container;
  44 using namespace css::lang;
  45 using namespace css::uno;
  46
  47 namespace {
  48
  49 typedef ::cppu::AggImplInheritanceHelper2   <   UnoControlBase
  50                                             ,   css::awt::XAnimation
  51                                             ,   css::container::XContainerListener
  52                                             >   AnimatedImagesControl_Base;
  53
  54 class AnimatedImagesControl : public AnimatedImagesControl_Base
  55 {
  56 public:
  57     AnimatedImagesControl();
  58     OUString GetComponentServiceName() override;
  59
  60     // XAnimation
  61     virtual void SAL_CALL startAnimation(  ) override;
  62     virtual void SAL_CALL stopAnimation(  ) override;
  63     virtual sal_Bool SAL_CALL isAnimationRunning(  ) override;
  64
  65     // XServiceInfo
  66     OUString SAL_CALL getImplementationName(  ) override;
  67     css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
  68
  69     // XControl
  70     sal_Bool SAL_CALL setModel( const css::uno::Reference< css::awt::XControlModel >& i_rModel ) override;
  71     void SAL_CALL createPeer( const css::uno::Reference< css::awt::XToolkit >& i_toolkit, const css::uno::Reference< css::awt::XWindowPeer >& i_parentPeer ) override;
  72
  73
  74     // XContainerListener
  75     virtual void SAL_CALL elementInserted( const css::container::ContainerEvent& Event ) override;
  76     virtual void SAL_CALL elementRemoved( const css::container::ContainerEvent& Event ) override;
  77     virtual void SAL_CALL elementReplaced( const css::container::ContainerEvent& Event ) override;
  78
  79     // XEventListener
  80     virtual void SAL_CALL disposing( const css::lang::EventObject& i_event ) override;
  81 };
  82
  83     AnimatedImagesControl::AnimatedImagesControl()
  84         :AnimatedImagesControl_Base()
  85     {
  86     }
  87
  88
  89     OUString AnimatedImagesControl::GetComponentServiceName()
  90     {
  91         return OUString( "AnimatedImages" );
  92     }
  93
  94
  95     void SAL_CALL AnimatedImagesControl::startAnimation(  )
  96     {
  97         Reference< XAnimation > xAnimation( getPeer(), UNO_QUERY );
  98         if ( xAnimation.is() )
  99             xAnimation->startAnimation();
 100     }
 101
 102
 103     void SAL_CALL AnimatedImagesControl::stopAnimation(  )
 104     {
 105         Reference< XAnimation > xAnimation( getPeer(), UNO_QUERY );
 106         if ( xAnimation.is() )
 107             xAnimation->stopAnimation();
 108     }
 109
 110
 111     sal_Bool SAL_CALL AnimatedImagesControl::isAnimationRunning(  )
 112     {
 113         Reference< XAnimation > xAnimation( getPeer(), UNO_QUERY );
 114         if ( xAnimation.is() )
 115             return xAnimation->isAnimationRunning();
 116         return false;
 117     }
 118
 119
 120     OUString SAL_CALL AnimatedImagesControl::getImplementationName(  )
 121     {
 122         return OUString( "org.openoffice.comp.toolkit.AnimatedImagesControl" );
 123     }
 124
 125
 126     Sequence< OUString > SAL_CALL AnimatedImagesControl::getSupportedServiceNames()
 127     {
 128         Sequence< OUString > aServices( AnimatedImagesControl_Base::getSupportedServiceNames() );
 129         aServices.realloc( aServices.getLength() + 1 );
 130         aServices[ aServices.getLength() - 1 ] = "com.sun.star.awt.AnimatedImagesControl";
 131         return aServices;
 132     }
 133
 134     void lcl_updatePeer( Reference< XWindowPeer > const& i_peer, Reference< XControlModel > const& i_model )
 135     {
 136         const Reference< css::util::XModifyListener > xPeerModify( i_peer, UNO_QUERY );
 137         if ( xPeerModify.is() )
 138         {
 139             EventObject aEvent;
 140             aEvent.Source = i_model;
 141             xPeerModify->modified( aEvent );
 142         }
 143     }
 144
 145     sal_Bool SAL_CALL AnimatedImagesControl::setModel( const Reference< XControlModel >& i_rModel )
 146     {
 147         const Reference< XAnimatedImages > xOldContainer( getModel(), UNO_QUERY );
 148         const Reference< XAnimatedImages > xNewContainer( i_rModel, UNO_QUERY );
 149
 150         if ( !AnimatedImagesControl_Base::setModel( i_rModel ) )
 151             return false;
 152
 153         if ( xOldContainer.is() )
 154             xOldContainer->removeContainerListener( this );
 155
 156         if ( xNewContainer.is() )
 157             xNewContainer->addContainerListener( this );
 158
 159         lcl_updatePeer( getPeer(), getModel() );
 160
 161         return true;
 162     }
 163
 164
 165     void SAL_CALL AnimatedImagesControl::createPeer( const Reference< XToolkit >& i_toolkit, const Reference< XWindowPeer >& i_parentPeer )
 166     {
 167         AnimatedImagesControl_Base::createPeer( i_toolkit, i_parentPeer );
 168
 169         lcl_updatePeer( getPeer(), getModel() );
 170     }
 171
 172
 173     void SAL_CALL AnimatedImagesControl::elementInserted( const ContainerEvent& i_event )
 174     {
 175         const Reference< XContainerListener > xPeerListener( getPeer(), UNO_QUERY );
 176         if ( xPeerListener.is() )
 177             xPeerListener->elementInserted( i_event );
 178     }
 179
 180
 181     void SAL_CALL AnimatedImagesControl::elementRemoved( const ContainerEvent& i_event )
 182     {
 183         const Reference< XContainerListener > xPeerListener( getPeer(), UNO_QUERY );
 184         if ( xPeerListener.is() )
 185             xPeerListener->elementRemoved( i_event );
 186     }
 187
 188
 189     void SAL_CALL AnimatedImagesControl::elementReplaced( const ContainerEvent& i_event )
 190     {
 191         const Reference< XContainerListener > xPeerListener( getPeer(), UNO_QUERY );
 192         if ( xPeerListener.is() )
 193             xPeerListener->elementReplaced( i_event );
 194     }
 195
 196
 197     void SAL_CALL AnimatedImagesControl::disposing( const EventObject& i_event )
 198     {
 199         UnoControlBase::disposing( i_event );
 200     }
 201
 202 }
 203
 204 namespace toolkit {
 205
 206     struct AnimatedImagesControlModel_Data
 207     {
 208         ::std::vector< Sequence< OUString > >    aImageSets;
 209     };
 210
 211     namespace
 212     {
 213         void lcl_checkIndex( const AnimatedImagesControlModel_Data& i_data, const sal_Int32 i_index, const Reference< XInterface >& i_context,
 214             const bool i_forInsert = false )
 215         {
 216             if ( ( i_index < 0 ) || ( size_t( i_index ) > i_data.aImageSets.size() + ( i_forInsert ? 1 : 0 ) ) )
 217                 throw IndexOutOfBoundsException( OUString(), i_context );
 218         }
 219
 220         void lcl_notify( ::osl::ClearableMutexGuard& i_guard, ::cppu::OBroadcastHelper const & i_broadcaseHelper,
 221             void ( SAL_CALL XContainerListener::*i_notificationMethod )( const ContainerEvent& ),
 222             const sal_Int32 i_accessor, const Sequence< OUString >& i_imageURLs, const Reference< XInterface >& i_context )
 223         {
 224             ::cppu::OInterfaceContainerHelper* pContainerListeners = i_broadcaseHelper.getContainer( cppu::UnoType<XContainerListener>::get() );
 225             if ( pContainerListeners == nullptr )
 226                 return;
 227
 228             ContainerEvent aEvent;
 229             aEvent.Source = i_context;
 230             aEvent.Accessor <<= i_accessor;
 231             aEvent.Element <<= i_imageURLs;
 232
 233             i_guard.clear();
 234             pContainerListeners->notifyEach( i_notificationMethod, aEvent );
 235         }
 236     }
 237
 238
 239     AnimatedImagesControlModel::AnimatedImagesControlModel( Reference< css::uno::XComponentContext > const & i_factory )
 240         :AnimatedImagesControlModel_Base( i_factory )
 241         ,m_xData( new AnimatedImagesControlModel_Data )
 242     {
 243         ImplRegisterProperty( BASEPROPERTY_AUTO_REPEAT );
 244         ImplRegisterProperty( BASEPROPERTY_BORDER );
 245         ImplRegisterProperty( BASEPROPERTY_BORDERCOLOR );
 246         ImplRegisterProperty( BASEPROPERTY_BACKGROUNDCOLOR );
 247         ImplRegisterProperty( BASEPROPERTY_DEFAULTCONTROL );
 248         ImplRegisterProperty( BASEPROPERTY_ENABLEVISIBLE );
 249         ImplRegisterProperty( BASEPROPERTY_HELPTEXT );
 250         ImplRegisterProperty( BASEPROPERTY_HELPURL );
 251         ImplRegisterProperty( BASEPROPERTY_IMAGE_SCALE_MODE );
 252         ImplRegisterProperty( BASEPROPERTY_STEP_TIME );
 253     }
 254
 255
 256     AnimatedImagesControlModel::AnimatedImagesControlModel( const AnimatedImagesControlModel& i_copySource )
 257         :AnimatedImagesControlModel_Base( i_copySource )
 258         ,m_xData( new AnimatedImagesControlModel_Data( *i_copySource.m_xData ) )
 259     {
 260     }
 261
 262
 263     AnimatedImagesControlModel::~AnimatedImagesControlModel()
 264     {
 265     }
 266
 267
 268     rtl::Reference<UnoControlModel> AnimatedImagesControlModel::Clone() const
 269     {
 270         return new AnimatedImagesControlModel( *this );
 271     }
 272
 273
 274     Reference< css::beans::XPropertySetInfo > SAL_CALL AnimatedImagesControlModel::getPropertySetInfo(  )
 275     {
 276         static Reference< css::beans::XPropertySetInfo > xInfo( createPropertySetInfo( getInfoHelper() ) );
 277         return xInfo;
 278     }
 279
 280
 281     OUString SAL_CALL AnimatedImagesControlModel::getServiceName()
 282     {
 283         return OUString("com.sun.star.awt.AnimatedImagesControlModel");
 284     }
 285
 286
 287     OUString SAL_CALL AnimatedImagesControlModel::getImplementationName(  )
 288     {
 289         return OUString("org.openoffice.comp.toolkit.AnimatedImagesControlModel");
 290     }
 291
 292
 293     Sequence< OUString > SAL_CALL AnimatedImagesControlModel::getSupportedServiceNames()
 294     {
 295         Sequence< OUString > aServiceNames(2);
 296         aServiceNames[0] = "com.sun.star.awt.AnimatedImagesControlModel";
 297         aServiceNames[1] = "com.sun.star.awt.UnoControlModel";
 298         return aServiceNames;
 299     }
 300
 301
 302     void SAL_CALL AnimatedImagesControlModel::setFastPropertyValue_NoBroadcast( sal_Int32 i_handle, const Any& i_value )
 303     {
 304         switch ( i_handle )
 305         {
 306         case BASEPROPERTY_IMAGE_SCALE_MODE:
 307         {
 308             sal_Int16 nImageScaleMode( ImageScaleMode::ANISOTROPIC );
 309             OSL_VERIFY( i_value >>= nImageScaleMode );  // convertFastPropertyValue ensures that this has the proper type
 310             if  (   ( nImageScaleMode != ImageScaleMode::NONE )
 311                 &&  ( nImageScaleMode != ImageScaleMode::ISOTROPIC )
 312                 &&  ( nImageScaleMode != ImageScaleMode::ANISOTROPIC )
 313                 )
 314                 throw IllegalArgumentException( OUString(), *this, 1 );
 315         }
 316         break;
 317         }
 318
 319         AnimatedImagesControlModel_Base::setFastPropertyValue_NoBroadcast( i_handle, i_value );
 320     }
 321
 322
 323     Any AnimatedImagesControlModel::ImplGetDefaultValue( sal_uInt16 i_propertyId ) const
 324     {
 325         switch ( i_propertyId )
 326         {
 327         case BASEPROPERTY_DEFAULTCONTROL:
 328             return makeAny( OUString("com.sun.star.awt.AnimatedImagesControl") );
 329
 330         case BASEPROPERTY_BORDER:
 331             return makeAny( css::awt::VisualEffect::NONE );
 332
 333         case BASEPROPERTY_STEP_TIME:
 334             return makeAny( sal_Int32(100) );
 335
 336         case BASEPROPERTY_AUTO_REPEAT:
 337             return makeAny( true );
 338
 339         case BASEPROPERTY_IMAGE_SCALE_MODE:
 340             return makeAny( ImageScaleMode::NONE );
 341
 342         default:
 343             return UnoControlModel::ImplGetDefaultValue( i_propertyId );
 344         }
 345     }
 346
 347
 348     ::cppu::IPropertyArrayHelper& SAL_CALL AnimatedImagesControlModel::getInfoHelper()
 349     {
 350         static UnoPropertyArrayHelper* pHelper = nullptr;
 351         if ( !pHelper )
 352         {
 353             Sequence< sal_Int32 > aIDs = ImplGetPropertyIds();
 354             pHelper = new UnoPropertyArrayHelper( aIDs );
 355         }
 356         return *pHelper;
 357     }
 358
 359
 360     ::sal_Int32 SAL_CALL AnimatedImagesControlModel::getStepTime()
 361     {
 362         sal_Int32 nStepTime( 100 );
 363         OSL_VERIFY( getPropertyValue( GetPropertyName( BASEPROPERTY_STEP_TIME ) ) >>= nStepTime );
 364         return nStepTime;
 365     }
 366
 367
 368     void SAL_CALL AnimatedImagesControlModel::setStepTime( ::sal_Int32 i_stepTime )
 369     {
 370         setPropertyValue( GetPropertyName( BASEPROPERTY_STEP_TIME ), makeAny( i_stepTime ) );
 371     }
 372
 373
 374     sal_Bool SAL_CALL AnimatedImagesControlModel::getAutoRepeat()
 375     {
 376         bool bAutoRepeat( true );
 377         OSL_VERIFY( getPropertyValue( GetPropertyName( BASEPROPERTY_AUTO_REPEAT ) ) >>= bAutoRepeat );
 378         return bAutoRepeat;
 379     }
 380
 381
 382     void SAL_CALL AnimatedImagesControlModel::setAutoRepeat( sal_Bool i_autoRepeat )
 383     {
 384         setPropertyValue( GetPropertyName( BASEPROPERTY_AUTO_REPEAT ), makeAny( i_autoRepeat ) );
 385     }
 386
 387
 388     ::sal_Int16 SAL_CALL AnimatedImagesControlModel::getScaleMode()
 389     {
 390         sal_Int16 nImageScaleMode( ImageScaleMode::ANISOTROPIC );
 391         OSL_VERIFY( getPropertyValue( GetPropertyName( BASEPROPERTY_IMAGE_SCALE_MODE ) ) >>= nImageScaleMode );
 392         return nImageScaleMode;
 393     }
 394
 395
 396     void SAL_CALL AnimatedImagesControlModel::setScaleMode( ::sal_Int16 i_scaleMode )
 397     {
 398         setPropertyValue( GetPropertyName( BASEPROPERTY_IMAGE_SCALE_MODE ), makeAny( i_scaleMode ) );
 399     }
 400
 401
 402     ::sal_Int32 SAL_CALL AnimatedImagesControlModel::getImageSetCount(  )
 403     {
 404         ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 405         if ( GetBroadcastHelper().bDisposed || GetBroadcastHelper().bInDispose )
 406             throw DisposedException();
 407
 408         return m_xData->aImageSets.size();
 409     }
 410
 411
 412     Sequence< OUString > SAL_CALL AnimatedImagesControlModel::getImageSet( ::sal_Int32 i_index )
 413     {
 414         ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 415         if ( GetBroadcastHelper().bDisposed || GetBroadcastHelper().bInDispose )
 416             throw DisposedException();
 417
 418         lcl_checkIndex( *m_xData, i_index, *this );
 419
 420         return m_xData->aImageSets[ i_index ];
 421     }
 422
 423
 424     void SAL_CALL AnimatedImagesControlModel::insertImageSet( ::sal_Int32 i_index, const Sequence< OUString >& i_imageURLs )
 425     {
 426         ::osl::ClearableMutexGuard aGuard( GetMutex() );
 427         // sanity checks
 428         if ( GetBroadcastHelper().bDisposed || GetBroadcastHelper().bInDispose )
 429             throw DisposedException();
 430
 431         lcl_checkIndex( *m_xData, i_index, *this, true );
 432
 433         // actual insertion
 434         m_xData->aImageSets.insert( m_xData->aImageSets.begin() + i_index, i_imageURLs );
 435
 436         // listener notification
 437         lcl_notify( aGuard, BrdcstHelper, &XContainerListener::elementInserted, i_index, i_imageURLs, *this );
 438     }
 439
 440
 441     void SAL_CALL AnimatedImagesControlModel::replaceImageSet( ::sal_Int32 i_index, const Sequence< OUString >& i_imageURLs )
 442     {
 443         ::osl::ClearableMutexGuard aGuard( GetMutex() );
 444         // sanity checks
 445         if ( GetBroadcastHelper().bDisposed || GetBroadcastHelper().bInDispose )
 446             throw DisposedException();
 447
 448         lcl_checkIndex( *m_xData, i_index, *this );
 449
 450         // actual insertion
 451         m_xData->aImageSets[ i_index ] = i_imageURLs;
 452
 453         // listener notification
 454         lcl_notify( aGuard, BrdcstHelper, &XContainerListener::elementReplaced, i_index, i_imageURLs, *this );
 455     }
 456
 457
 458     void SAL_CALL AnimatedImagesControlModel::removeImageSet( ::sal_Int32 i_index )
 459     {
 460         ::osl::ClearableMutexGuard aGuard( GetMutex() );
 461         // sanity checks
 462         if ( GetBroadcastHelper().bDisposed || GetBroadcastHelper().bInDispose )
 463             throw DisposedException();
 464
 465         lcl_checkIndex( *m_xData, i_index, *this );
 466
 467         // actual removal
 468         ::std::vector< Sequence< OUString > >::iterator removalPos = m_xData->aImageSets.begin() + i_index;
 469         Sequence< OUString > aRemovedElement( *removalPos );
 470         m_xData->aImageSets.erase( removalPos );
 471
 472         // listener notification
 473         lcl_notify( aGuard, BrdcstHelper, &XContainerListener::elementRemoved, i_index, aRemovedElement, *this );
 474     }
 475
 476
 477     void SAL_CALL AnimatedImagesControlModel::addContainerListener( const Reference< XContainerListener >& i_listener )
 478     {
 479         BrdcstHelper.addListener( cppu::UnoType<XContainerListener>::get(), i_listener );
 480     }
 481
 482
 483     void SAL_CALL AnimatedImagesControlModel::removeContainerListener( const Reference< XContainerListener >& i_listener )
 484     {
 485         BrdcstHelper.removeListener( cppu::UnoType<XContainerListener>::get(), i_listener );
 486     }
 487
 488 }
 489
 490 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface *
 491 org_openoffice_comp_toolkit_AnimatedImagesControl_get_implementation(
 492     css::uno::XComponentContext *,
 493     css::uno::Sequence<css::uno::Any> const &)
 494 {
 495     return cppu::acquire(new AnimatedImagesControl());
 496 }
 497
 498 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface *
 499 org_openoffice_comp_toolkit_AnimatedImagesControlModel_get_implementation(
 500     css::uno::XComponentContext *context,
 501     css::uno::Sequence<css::uno::Any> const &)
 502 {
 503     return cppu::acquire(new toolkit::AnimatedImagesControlModel(context));
 504 }
 505
 506 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */