sd/source/ui/slideshow/slideshowimpl.hxx

   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 #pragma once
  21
  22 #include <memory>
  23 #include <sal/config.h>
  24 #include <comphelper/compbase.hxx>
  25 #include <cppuhelper/implbase.hxx>
  26 #include <comphelper/interfacecontainer4.hxx>
  27 #include <com/sun/star/presentation/ClickAction.hpp>
  28 #include <com/sun/star/presentation/XSlideShowNavigationListener.hpp>
  29 #include <com/sun/star/presentation/XSlideShowController.hpp>
  30 #include <com/sun/star/presentation/XShapeEventListener.hpp>
  31
  32 #include <drawdoc.hxx>
  33
  34 #include "showwindow.hxx"
  35
  36 #include <slideshow.hxx>
  37
  38 namespace com::sun::star::frame { class XModel; }
  39 namespace com::sun::star::media { class XPlayer; }
  40 namespace sd { class DrawDocShell; }
  41 namespace sd { class ViewShell; }
  42
  43 class SfxBindings;
  44 class SfxDispatcher;
  45 class SfxViewFrame;
  46 class StarBASIC;
  47
  48 namespace sd
  49 {
  50 class SlideShowView;
  51 class AnimationSlideController;
  52 class PaneHider;
  53
  54 struct PresentationSettingsEx : public PresentationSettings
  55 {
  56     bool mbRehearseTimings;
  57     bool mbPreview;
  58     VclPtr<vcl::Window> mpParentWindow;
  59     css::uno::Reference< css::drawing::XDrawPage > mxStartPage;
  60     css::uno::Reference< css::animations::XAnimationNode > mxAnimationNode;
  61
  62     PresentationSettingsEx( const PresentationSettingsEx& );
  63     explicit PresentationSettingsEx( PresentationSettings const & );
  64
  65     /// @throws css::lang::IllegalArgumentException
  66     void SetArguments( const css::uno::Sequence< css::beans::PropertyValue >& rArguments );
  67
  68     /// @throws css::lang::IllegalArgumentException
  69     void SetPropertyValue( std::u16string_view rProperty, const css::uno::Any& rValue );
  70 };
  71
  72 struct WrappedShapeEventImpl
  73 {
  74     css::presentation::ClickAction meClickAction;
  75     sal_Int32 mnVerb;
  76     OUString maStrBookmark;
  77     WrappedShapeEventImpl() : meClickAction( css::presentation::ClickAction_NONE ), mnVerb( 0 ) {};
  78 };
  79
  80 typedef std::shared_ptr< WrappedShapeEventImpl > WrappedShapeEventImplPtr;
  81
  82 class SlideShowListenerProxy :
  83         public ::cppu::WeakImplHelper< css::presentation::XSlideShowNavigationListener, css::presentation::XShapeEventListener >
  84 {
  85 public:
  86     SlideShowListenerProxy( rtl::Reference< SlideshowImpl > xController, css::uno::Reference< css::presentation::XSlideShow > xSlideShow );
  87     virtual ~SlideShowListenerProxy() override;
  88
  89     void addAsSlideShowListener();
  90     void removeAsSlideShowListener();
  91
  92     void addSlideShowListener( const css::uno::Reference< css::presentation::XSlideShowListener >& Listener );
  93     void removeSlideShowListener( const css::uno::Reference< css::presentation::XSlideShowListener >& Listener );
  94
  95     void addShapeEventListener( const css::uno::Reference< css::drawing::XShape >& xShape );
  96     void removeShapeEventListener( const css::uno::Reference< css::drawing::XShape >& xShape );
  97
  98     // css::animations::XAnimationListener
  99     virtual void SAL_CALL beginEvent( const css::uno::Reference< css::animations::XAnimationNode >& Node ) override;
 100     virtual void SAL_CALL endEvent( const css::uno::Reference< css::animations::XAnimationNode >& Node ) override;
 101     virtual void SAL_CALL repeat( const css::uno::Reference< css::animations::XAnimationNode >& Node, ::sal_Int32 Repeat ) override;
 102
 103     // css::presentation::XSlideShowListener:
 104     virtual void SAL_CALL paused() override;
 105     virtual void SAL_CALL resumed() override;
 106     virtual void SAL_CALL slideTransitionStarted() override;
 107     virtual void SAL_CALL slideTransitionEnded() override;
 108     virtual void SAL_CALL slideAnimationsEnded() override;
 109     virtual void SAL_CALL slideEnded(sal_Bool bReverse) override;
 110     virtual void SAL_CALL hyperLinkClicked(const OUString & hyperLink) override;
 111
 112     // css::presentation::XSlideShowNavigationListener:
 113     virtual void SAL_CALL contextMenuShow(const css::awt::Point& point) override;
 114
 115     // css::lang::XEventListener:
 116     virtual void SAL_CALL disposing(const css::lang::EventObject & Source) override;
 117
 118     // css::presentation::XShapeEventListener:
 119     virtual void SAL_CALL click(const css::uno::Reference< css::drawing::XShape > & xShape, const css::awt::MouseEvent & aOriginalEvent) override;
 120
 121 private:
 122     std::mutex m_aMutex;
 123     ::comphelper::OInterfaceContainerHelper4<css::presentation::XSlideShowListener> maListeners;
 124     rtl::Reference< SlideshowImpl > mxController;
 125     css::uno::Reference< css::presentation::XSlideShow > mxSlideShow;
 126 };
 127
 128 typedef comphelper::WeakComponentImplHelper< css::presentation::XSlideShowController, css::container::XIndexAccess > SlideshowImplBase;
 129
 130 class SlideshowImpl final : public SlideshowImplBase
 131 {
 132 friend class SlideShow;
 133 friend class SlideShowView;
 134
 135 public:
 136     explicit SlideshowImpl( const css::uno::Reference< css::presentation::XPresentation2 >& xPresentation, ViewShell* pViewSh, ::sd::View* pView, SdDrawDocument* pDoc, vcl::Window* pParentWindow);
 137
 138     // css::presentation::XSlideShowController:
 139     virtual sal_Bool SAL_CALL getAlwaysOnTop() override;
 140     virtual void SAL_CALL setAlwaysOnTop( sal_Bool _alwaysontop ) override;
 141     virtual sal_Bool SAL_CALL getMouseVisible() override;
 142     virtual void SAL_CALL setMouseVisible( sal_Bool _mousevisible ) override;
 143     virtual sal_Bool SAL_CALL getUsePen() override;
 144     virtual void SAL_CALL setUsePen( sal_Bool _usepen ) override;
 145     virtual ::sal_Int32 SAL_CALL getPenColor() override;
 146     virtual void SAL_CALL setPenColor( ::sal_Int32 _pencolor ) override;
 147     virtual double SAL_CALL getPenWidth() override;
 148     virtual void SAL_CALL setPenWidth( double dStrokeWidth ) override;
 149     /// @throws css::uno::RuntimeException
 150     virtual void SAL_CALL setEraseAllInk( sal_Bool bEraseAllInk ) override;
 151     virtual sal_Bool SAL_CALL isRunning(  ) override;
 152     virtual ::sal_Int32 SAL_CALL getSlideCount(  ) override;
 153     virtual css::uno::Reference< css::drawing::XDrawPage > SAL_CALL getSlideByIndex( ::sal_Int32 Index ) override;
 154     virtual void SAL_CALL addSlideShowListener( const css::uno::Reference< css::presentation::XSlideShowListener >& Listener ) override;
 155     virtual void SAL_CALL removeSlideShowListener( const css::uno::Reference< css::presentation::XSlideShowListener >& Listener ) override;
 156     virtual void SAL_CALL gotoNextEffect(  ) override;
 157     virtual void SAL_CALL gotoPreviousEffect(  ) override;
 158     virtual void SAL_CALL gotoFirstSlide(  ) override;
 159     virtual void SAL_CALL gotoNextSlide(  ) override;
 160     virtual void SAL_CALL gotoPreviousSlide(  ) override;
 161     virtual void SAL_CALL gotoLastSlide(  ) override;
 162     virtual void SAL_CALL gotoBookmark( const OUString& Bookmark ) override;
 163     virtual void SAL_CALL gotoSlide( const css::uno::Reference< css::drawing::XDrawPage >& Page ) override;
 164     virtual void SAL_CALL gotoSlideIndex( ::sal_Int32 Index ) override;
 165     virtual void SAL_CALL stopSound(  ) override;
 166     virtual void SAL_CALL pause(  ) override;
 167     virtual void SAL_CALL resume(  ) override;
 168     virtual sal_Bool SAL_CALL isPaused(  ) override;
 169     virtual void SAL_CALL blankScreen( ::sal_Int32 Color ) override;
 170     virtual void SAL_CALL activate(  ) override;
 171     virtual void SAL_CALL deactivate(  ) override;
 172     virtual sal_Bool SAL_CALL isActive(  ) override;
 173     virtual css::uno::Reference< css::drawing::XDrawPage > SAL_CALL getCurrentSlide(  ) override;
 174     virtual ::sal_Int32 SAL_CALL getCurrentSlideIndex(  ) override;
 175     virtual ::sal_Int32 SAL_CALL getNextSlideIndex(  ) override;
 176     virtual sal_Bool SAL_CALL isEndless(  ) override;
 177     virtual sal_Bool SAL_CALL isFullScreen(  ) override;
 178     virtual css::uno::Reference< css::presentation::XSlideShow > SAL_CALL getSlideShow(  ) override;
 179
 180     // XIndexAccess
 181     virtual ::sal_Int32 SAL_CALL getCount(  ) override;
 182     virtual css::uno::Any SAL_CALL getByIndex( ::sal_Int32 Index ) override;
 183     virtual css::uno::Type SAL_CALL getElementType(  ) override;
 184     virtual sal_Bool SAL_CALL hasElements(  ) override;
 185
 186     // will be called from the SlideShowListenerProxy when this event is fired from the XSlideShow
 187     void slideEnded(const bool bReverse);
 188     void contextMenuShow(const css::awt::Point& point);
 189     /// @throws css::uno::RuntimeException
 190     void hyperLinkClicked(const OUString & hyperLink);
 191     void click(const css::uno::Reference< css::drawing::XShape > & xShape);
 192     bool swipe(const CommandGestureSwipeData &rSwipeData);
 193     bool longpress(const CommandGestureLongPressData& rLongPressData);
 194
 195     /// ends the presentation async
 196     void endPresentation();
 197
 198     ViewShell* getViewShell() const { return mpViewShell; }
 199
 200     void paint();
 201     bool keyInput(const KeyEvent& rKEvt);
 202     void mouseButtonUp(const MouseEvent& rMEvt);
 203
 204 private:
 205     SlideshowImpl(SlideshowImpl const &) = delete;
 206     void operator =(SlideshowImpl const &) = delete;
 207
 208     virtual ~SlideshowImpl() override;
 209
 210     // override WeakComponentImplHelperBase::disposing()
 211     // This function is called upon disposing the component,
 212     // if your component needs special work when it becomes
 213     // disposed, do it here.
 214     virtual void disposing(std::unique_lock<std::mutex>&) override;
 215
 216     // internal
 217     bool startShow( PresentationSettingsEx const * pPresSettings );
 218     bool startPreview(
 219         const css::uno::Reference< css::drawing::XDrawPage >& xDrawPage,
 220         const css::uno::Reference< css::animations::XAnimationNode >& xAnimationNode,
 221         vcl::Window* pParent );
 222
 223         /** forces an async call to update in the main thread */
 224     void startUpdateTimer();
 225
 226     void update();
 227
 228     void createSlideList( bool bAll, std::u16string_view rPresSlide );
 229
 230     void displayCurrentSlide (const bool bSkipAllMainSequenceEffects = false);
 231
 232     void displaySlideNumber( sal_Int32 nSlide );
 233     void displaySlideIndex( sal_Int32 nIndex );
 234     sal_Int32 getCurrentSlideNumber() const;
 235     bool isInputFreezed() const { return mbInputFreeze; }
 236
 237     void jumpToBookmark( const OUString& sBookmark );
 238
 239     void hideChildWindows();
 240     void showChildWindows();
 241
 242     void resize( const Size& rSize );
 243
 244     void setActiveXToolbarsVisible( bool bVisible );
 245
 246     DECL_LINK( updateHdl, Timer *, void );
 247     DECL_LINK( ReadyForNextInputHdl, Timer *, void );
 248     DECL_LINK( endPresentationHdl, void*, void );
 249     void ContextMenuSelectHdl(std::u16string_view rIdent);
 250     DECL_LINK( ContextMenuHdl, void*, void );
 251     DECL_LINK( deactivateHdl, Timer *, void );
 252     DECL_LINK( EventListenerHdl, VclSimpleEvent&, void );
 253
 254     /** called only by the slideshow view when the first paint event occurs.
 255         This actually starts the slideshow. */
 256     void onFirstPaint();
 257
 258     ::tools::Long getRestoreSlide() const { return mnRestoreSlide; }
 259
 260 private:
 261     bool startShowImpl(
 262         const css::uno::Sequence< css::beans::PropertyValue >& aProperties );
 263
 264     SfxViewFrame* getViewFrame() const;
 265     SfxDispatcher* getDispatcher() const;
 266     SfxBindings* getBindings() const;
 267
 268     sal_Int32 getSlideNumberForBookmark( const OUString& rStrBookmark );
 269
 270     void removeShapeEvents();
 271     void registerShapeEvents( sal_Int32 nSlideNumber );
 272     /// @throws css::uno::Exception
 273     void registerShapeEvents( css::uno::Reference< css::drawing::XShapes > const & xShapes );
 274
 275     static css::uno::Reference< css::presentation::XSlideShow > createSlideShow();
 276
 277     static void setAutoSaveState( bool bOn );
 278     void gotoPreviousSlide (const bool bSkipAllMainSequenceEffects);
 279
 280     /** Called by our maUpdateTimer's updateHdl handler this method is
 281         responsible to call the slideshow update() method and, depending on
 282         its return value, wait for a certain amount of time before another
 283         call to update() is scheduled.
 284     */
 285     void updateSlideShow();
 286
 287     css::uno::Reference< css::presentation::XSlideShow > mxShow;
 288     rtl::Reference<sd::SlideShowView> mxView;
 289     css::uno::Reference< css::frame::XModel > mxModel;
 290
 291     Timer maUpdateTimer;
 292     Timer maInputFreezeTimer;
 293     Timer maDeactivateTimer;
 294
 295     ::sd::View* mpView;
 296     ViewShell* mpViewShell;
 297     DrawDocShell* mpDocSh;
 298     SdDrawDocument* mpDoc;
 299
 300     VclPtr<vcl::Window>    mpParentWindow;
 301     VclPtr<sd::ShowWindow>     mpShowWindow;
 302
 303     std::shared_ptr< AnimationSlideController > mpSlideController;
 304
 305     ::tools::Long            mnRestoreSlide;
 306     Point           maPopupMousePos;
 307     Size            maPresSize;
 308     AnimationMode   meAnimationMode;
 309     OUString        maCharBuffer;
 310     VclPtr< ::sd::Window>   mpOldActiveWindow;
 311     Link<StarBASIC*,bool>   maStarBASICGlobalErrorHdl;
 312     ::tools::ULong    mnChildMask;
 313     bool            mbDisposed;
 314     bool            mbAutoSaveWasOn;
 315     bool            mbRehearseTimings;
 316     bool            mbIsPaused;
 317     bool            mbWasPaused;        // used to cache pause state during context menu
 318     bool            mbInputFreeze;
 319     bool            mbActive;
 320
 321     PresentationSettings maPresSettings;
 322     sal_Int32       mnUserPaintColor;
 323
 324     bool            mbUsePen;
 325     double          mdUserPaintStrokeWidth;
 326
 327     std::map< css::uno::Reference< css::drawing::XShape >, WrappedShapeEventImplPtr >
 328                     maShapeEventMap;
 329
 330     css::uno::Reference< css::drawing::XDrawPage > mxPreviewDrawPage;
 331     css::uno::Reference< css::animations::XAnimationNode > mxPreviewAnimationNode;
 332
 333     css::uno::Reference< css::media::XPlayer > mxPlayer;
 334
 335     ::std::unique_ptr<PaneHider> mpPaneHider;
 336
 337     ImplSVEvent * mnEndShowEvent;
 338     ImplSVEvent * mnContextMenuEvent;
 339
 340     css::uno::Reference< css::presentation::XPresentation2 > mxPresentation;
 341     ::rtl::Reference< SlideShowListenerProxy > mxListenerProxy;
 342 };
 343
 344 } // namespace ::sd
 345
 346 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */