slideshow/source/engine/shapes/appletshape.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 <canvas/canvastools.hxx>
  22
  23 #include "appletshape.hxx"
  24 #include "externalshapebase.hxx"
  25 #include <vieweventhandler.hxx>
  26 #include "viewappletshape.hxx"
  27 #include <tools.hxx>
  28
  29 #include <algorithm>
  30
  31
  32 using namespace ::com::sun::star;
  33
  34
  35 namespace slideshow
  36 {
  37     namespace internal
  38     {
  39         /** Represents an applet shape.
  40
  41             This implementation offers support for applet shapes (both
  42             Java applets, and Netscape plugins). Such shapes need
  43             special treatment.
  44          */
  45         class AppletShape : public ExternalShapeBase
  46         {
  47         public:
  48             /** Create a shape for the given XShape for a applet object
  49
  50                 @param xShape
  51                 The XShape to represent.
  52
  53                 @param nPrio
  54                 Externally-determined shape priority (used e.g. for
  55                 paint ordering). This number _must be_ unique!
  56
  57                 @param rServiceName
  58                 Service name to use, when creating the actual viewer
  59                 component
  60
  61                 @param pPropCopyTable
  62                 Table of plain ASCII property names, to copy from
  63                 xShape to applet.
  64
  65                 @param nNumPropEntries
  66                 Number of property table entries (in pPropCopyTable)
  67              */
  68             AppletShape( const css::uno::Reference< css::drawing::XShape >& xShape,
  69                          double                                     nPrio,
  70                          const OUString&                            rServiceName,
  71                          const char**                               pPropCopyTable,
  72                          std::size_t                                nNumPropEntries,
  73                          const SlideShowContext&                    rContext ); // throw ShapeLoadFailedException;
  74
  75         private:
  76
  77             // View layer methods
  78
  79
  80             virtual void addViewLayer( const ViewLayerSharedPtr&    rNewLayer,
  81                                        bool                         bRedrawLayer ) override;
  82             virtual bool removeViewLayer( const ViewLayerSharedPtr& rNewLayer ) override;
  83             virtual void clearAllViewLayers() override;
  84
  85
  86             // ExternalShapeBase methods
  87
  88
  89             virtual bool implRender( const ::basegfx::B2DRange& rCurrBounds ) const override;
  90             virtual void implViewChanged( const UnoViewSharedPtr& rView ) override;
  91             virtual void implViewsChanged() override;
  92             virtual bool implStartIntrinsicAnimation() override;
  93             virtual bool implEndIntrinsicAnimation() override;
  94             virtual void implPauseIntrinsicAnimation() override;
  95             virtual bool implIsIntrinsicAnimationPlaying() const override;
  96             virtual void implSetIntrinsicAnimationTime(double) override;
  97
  98             const OUString                           maServiceName;
  99             const char**                                    mpPropCopyTable;
 100             const std::size_t                        mnNumPropEntries;
 101
 102             /// the list of active view shapes (one for each registered view layer)
 103             typedef ::std::vector< ViewAppletShapeSharedPtr > ViewAppletShapeVector;
 104             ViewAppletShapeVector                           maViewAppletShapes;
 105             bool                                             mbIsPlaying;
 106         };
 107
 108         AppletShape::AppletShape( const uno::Reference< drawing::XShape >& xShape,
 109                                   double                                   nPrio,
 110                                   const OUString&                   rServiceName,
 111                                   const char**                             pPropCopyTable,
 112                                   std::size_t                                 nNumPropEntries,
 113                                   const SlideShowContext&                  rContext ) :
 114             ExternalShapeBase( xShape, nPrio, rContext ),
 115             maServiceName( rServiceName ),
 116             mpPropCopyTable( pPropCopyTable ),
 117             mnNumPropEntries( nNumPropEntries ),
 118             maViewAppletShapes(),
 119             mbIsPlaying(false)
 120         {
 121         }
 122
 123
 124         void AppletShape::implViewChanged( const UnoViewSharedPtr& rView )
 125         {
 126             const ::basegfx::B2DRectangle& rBounds = getBounds();
 127             // determine ViewAppletShape that needs update
 128             for( const auto& pViewAppletShape : maViewAppletShapes )
 129             {
 130                 if( pViewAppletShape->getViewLayer()->isOnView( rView ) )
 131                     pViewAppletShape->resize( rBounds );
 132             }
 133         }
 134
 135
 136         void AppletShape::implViewsChanged()
 137         {
 138             // resize all ViewShapes
 139             const ::basegfx::B2DRectangle& rBounds = getBounds();
 140             for( const auto& pViewAppletShape : maViewAppletShapes )
 141                 pViewAppletShape->resize( rBounds );
 142         }
 143
 144
 145         void AppletShape::addViewLayer( const ViewLayerSharedPtr& rNewLayer,
 146                                         bool                      bRedrawLayer )
 147         {
 148             try
 149             {
 150                 maViewAppletShapes.push_back(
 151                     std::make_shared<ViewAppletShape>( rNewLayer,
 152                                                        getXShape(),
 153                                                        maServiceName,
 154                                                        mpPropCopyTable,
 155                                                        mnNumPropEntries,
 156                                                        mxComponentContext ));
 157
 158                 // push new size to view shape
 159                 maViewAppletShapes.back()->resize( getBounds() );
 160
 161                 // render the Shape on the newly added ViewLayer
 162                 if( bRedrawLayer )
 163                     maViewAppletShapes.back()->render( getBounds() );
 164             }
 165             catch(uno::Exception&)
 166             {
 167                 // ignore failed shapes - slideshow should run with
 168                 // the remaining content
 169             }
 170         }
 171
 172
 173         bool AppletShape::removeViewLayer( const ViewLayerSharedPtr& rLayer )
 174         {
 175             const ViewAppletShapeVector::iterator aEnd( maViewAppletShapes.end() );
 176
 177             OSL_ENSURE( ::std::count_if(maViewAppletShapes.begin(),
 178                                         aEnd,
 179                                         [&rLayer]
 180                                         ( const ViewAppletShapeSharedPtr& pShape )
 181                                         { return rLayer == pShape->getViewLayer(); } ) < 2,
 182                         "AppletShape::removeViewLayer(): Duplicate ViewLayer entries!" );
 183
 184             ViewAppletShapeVector::iterator aIter;
 185
 186             if( (aIter=::std::remove_if( maViewAppletShapes.begin(),
 187                                          aEnd,
 188                                          [&rLayer]
 189                                          ( const ViewAppletShapeSharedPtr& pShape )
 190                                          { return rLayer == pShape->getViewLayer(); } ) ) == aEnd )
 191             {
 192                 // view layer seemingly was not added, failed
 193                 return false;
 194             }
 195
 196             // actually erase from container
 197             maViewAppletShapes.erase( aIter, aEnd );
 198
 199             return true;
 200         }
 201
 202
 203         void AppletShape::clearAllViewLayers()
 204         {
 205             maViewAppletShapes.clear();
 206         }
 207
 208
 209         bool AppletShape::implRender( const ::basegfx::B2DRange& rCurrBounds ) const
 210         {
 211             // redraw all view shapes, by calling their update() method
 212             if( ::std::count_if( maViewAppletShapes.begin(),
 213                                  maViewAppletShapes.end(),
 214                                  [&rCurrBounds]
 215                                  ( const ViewAppletShapeSharedPtr& pShape )
 216                                  { return pShape->render( rCurrBounds ); } )
 217                 != static_cast<ViewAppletShapeVector::difference_type>(maViewAppletShapes.size()) )
 218             {
 219                 // at least one of the ViewShape::update() calls did return
 220                 // false - update failed on at least one ViewLayer
 221                 return false;
 222             }
 223
 224             return true;
 225         }
 226
 227
 228         bool AppletShape::implStartIntrinsicAnimation()
 229         {
 230             const ::basegfx::B2DRectangle& rBounds = getBounds();
 231             for( const auto& pViewAppletShape : maViewAppletShapes )
 232                 pViewAppletShape->startApplet( rBounds );
 233
 234             mbIsPlaying = true;
 235
 236             return true;
 237         }
 238
 239
 240         bool AppletShape::implEndIntrinsicAnimation()
 241         {
 242             for( const auto& pViewAppletShape : maViewAppletShapes )
 243                 pViewAppletShape->endApplet();
 244
 245             mbIsPlaying = false;
 246
 247             return true;
 248         }
 249
 250
 251         void AppletShape::implPauseIntrinsicAnimation()
 252         {
 253             // TODO(F1): any way of temporarily disabling/deactivating
 254             // applets?
 255         }
 256
 257
 258         bool AppletShape::implIsIntrinsicAnimationPlaying() const
 259         {
 260             return mbIsPlaying;
 261         }
 262
 263
 264         void AppletShape::implSetIntrinsicAnimationTime(double)
 265         {
 266             // No way of doing this, or?
 267         }
 268
 269         std::shared_ptr<Shape> createAppletShape(
 270             const uno::Reference< drawing::XShape >& xShape,
 271             double                                   nPrio,
 272             const OUString&                   rServiceName,
 273             const char**                             pPropCopyTable,
 274             std::size_t                              nNumPropEntries,
 275             const SlideShowContext&                  rContext )
 276         {
 277             std::shared_ptr< AppletShape > pAppletShape(
 278                 new AppletShape(xShape,
 279                                 nPrio,
 280                                 rServiceName,
 281                                 pPropCopyTable,
 282                                 nNumPropEntries,
 283                                 rContext) );
 284
 285             return pAppletShape;
 286         }
 287     }
 288 }
 289
 290 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */