sd/source/ui/inc/slideshow.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 #ifndef INCLUDED_SD_SOURCE_UI_INC_SLIDESHOW_HXX
  21 #define INCLUDED_SD_SOURCE_UI_INC_SLIDESHOW_HXX
  22
  23 #include <com/sun/star/presentation/XPresentation2.hpp>
  24 #include <com/sun/star/lang/XServiceInfo.hpp>
  25
  26 #include <rtl/ref.hxx>
  27
  28 #include <tools/link.hxx>
  29
  30 #include <cppuhelper/compbase.hxx>
  31 #include <cppuhelper/basemutex.hxx>
  32
  33 #include <editeng/unoipset.hxx>
  34
  35 #include <memory>
  36
  37 namespace com { namespace sun { namespace star {
  38
  39     namespace drawing {
  40         class XDrawPage;
  41     }
  42     namespace animations {
  43         class XAnimationNode;
  44     }
  45 } } }
  46
  47 class SdDrawDocument;
  48 class KeyEvent;
  49 class OutputDevice;
  50 class Size;
  51 namespace vcl { class Window; }
  52 class SfxRequest;
  53 class WorkWindow;
  54 class CommandSwipeData;
  55 class CommandLongPressData;
  56 struct ImplSVEvent;
  57
  58 // TODO: Remove
  59 #define PAGE_NO_END         65535
  60
  61 /* Definition of SlideShow class */
  62
  63 namespace sd
  64 {
  65
  66 class SlideshowImpl;
  67 class View;
  68 class ViewShell;
  69 class ViewShellBase;
  70 struct PresentationSettingsEx;
  71 class FrameView;
  72
  73 enum AnimationMode
  74 {
  75     ANIMATIONMODE_SHOW,
  76     ANIMATIONMODE_PREVIEW
  77 };
  78
  79 typedef ::cppu::WeakComponentImplHelper< css::presentation::XPresentation2, css::lang::XServiceInfo > SlideshowBase;
  80
  81 class SlideShow : private ::cppu::BaseMutex, public SlideshowBase
  82 {
  83 public:
  84     /// used by the model to create a slideshow for it
  85     static rtl::Reference< SlideShow > Create( SdDrawDocument* pDoc );
  86
  87     // static helper api
  88     static rtl::Reference< SlideShow > GetSlideShow( SdDrawDocument const * pDocument );
  89     static rtl::Reference< SlideShow > GetSlideShow( SdDrawDocument const & rDocument );
  90     static rtl::Reference< SlideShow > GetSlideShow( ViewShellBase const & rBase );
  91
  92     static css::uno::Reference< css::presentation::XSlideShowController > GetSlideShowController(ViewShellBase const & rBase );
  93
  94     static bool StartPreview( ViewShellBase const & rBase,
  95         const css::uno::Reference< css::drawing::XDrawPage >& xDrawPage,
  96         const css::uno::Reference< css::animations::XAnimationNode >& xAnimationNode );
  97
  98     static void Stop( ViewShellBase const & rBase );
  99
 100     /// returns true if there is a running presentation for the given ViewShellBase
 101     static bool IsRunning( ViewShellBase const & rBase );
 102
 103     /// returns true if there is a running presentation inside the given ViewShell
 104     /// returns false even if there is a running presentation but in another ViewShell
 105     static bool IsRunning( ViewShell& rViewShell );
 106
 107     // helper api
 108
 109     void startPreview(
 110         const css::uno::Reference< css::drawing::XDrawPage >& xDrawPage,
 111         const css::uno::Reference< css::animations::XAnimationNode >& xAnimationNode );
 112
 113     // uno api
 114
 115         virtual void SAL_CALL disposing() override;
 116
 117     // XServiceInfo
 118     virtual OUString SAL_CALL getImplementationName(  ) override;
 119     virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
 120     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames(  ) override;
 121
 122     // XPropertySet
 123     virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  ) override;
 124     virtual void SAL_CALL setPropertyValue( const OUString& aPropertyName, const css::uno::Any& aValue ) override;
 125     virtual css::uno::Any SAL_CALL getPropertyValue( const OUString& PropertyName ) override;
 126     virtual void SAL_CALL addPropertyChangeListener( const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener ) override;
 127     virtual void SAL_CALL removePropertyChangeListener( const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& aListener ) override;
 128     virtual void SAL_CALL addVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
 129     virtual void SAL_CALL removeVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
 130
 131     // XPresentation
 132     virtual void SAL_CALL start(  ) override;
 133     virtual void SAL_CALL end() override;
 134     virtual void SAL_CALL rehearseTimings(  ) override;
 135
 136     // XPresentation2
 137     virtual void SAL_CALL startWithArguments(const css::uno::Sequence< css::beans::PropertyValue >& Arguments) override;
 138     virtual sal_Bool SAL_CALL isRunning(  ) override;
 139     virtual css::uno::Reference< css::presentation::XSlideShowController > SAL_CALL getController(  ) override;
 140
 141     // legacy api
 142
 143     // actions
 144     void jumpToPageNumber( sal_Int32 nPage );               // a.k.a. FuSlideShow::JumpToPage()
 145     void jumpToPageIndex( sal_Int32 nIndex );
 146     void jumpToBookmark( const OUString& sBookmark );            // a.k.a. FuSlideShow::JumpToBookmark()
 147
 148     /** sets or clears the pause state of the running slideshow.
 149         !!!! This should only be called by the SdShowWindow !!!!*/
 150     void pause( bool bPause );
 151     bool swipe(const CommandSwipeData &rSwipeData);
 152     bool longpress(const CommandLongPressData& rLongPressData);
 153
 154     // settings
 155     bool isFullScreen();                                // a.k.a. FuSlideShow::IsFullScreen()
 156     OutputDevice* getShowWindow();                      // a.k.a. FuSlideShow::GetShowWindow()
 157     int getAnimationMode();                             // a.k.a. FuSlideShow::GetAnimationMode()
 158     sal_Int32 getCurrentPageNumber();                   // a.k.a. FuSlideShow::GetCurrentPage()
 159
 160     // events
 161     void resize( const Size &rSize );
 162     void activate(ViewShellBase& rBase);
 163     void deactivate();
 164     void paint();
 165
 166     bool keyInput(const KeyEvent& rKEvt);
 167
 168     bool dependsOn( ViewShellBase const * pViewShellBase );
 169
 170     static sal_Int32 GetDisplay();
 171
 172     bool IsExitAfterPresenting() const;
 173     void SetExitAfterPresenting(bool bExit);
 174
 175 private:
 176     SlideShow( SdDrawDocument* pDoc );
 177
 178     DECL_LINK( StartInPlacePresentationConfigurationHdl, void *, void );
 179     void StartInPlacePresentationConfigurationCallback();
 180
 181     void StartInPlacePresentation();
 182     void StartFullscreenPresentation();
 183
 184     /// @throws css::uno::RuntimeException
 185     void ThrowIfDisposed() const;
 186
 187     void CreateController( ViewShell* pViewSh, ::sd::View* pView, vcl::Window* pParentWindow );
 188     WorkWindow *GetWorkWindow();
 189
 190     SlideShow(const SlideShow&) = delete;
 191     SlideShow& operator=( const SlideShow& ) = delete;
 192
 193     SvxItemPropertySet const  maPropSet;
 194
 195     rtl::Reference< SlideshowImpl > mxController;
 196     /** This flag is used together with mxController.is() to prevent
 197         multiple instances of the slide show for one document.  The flag
 198         covers the time before mxController is set.
 199     */
 200     bool mbIsInStartup;
 201     SdDrawDocument* mpDoc;
 202
 203     std::shared_ptr< PresentationSettingsEx > mxCurrentSettings;
 204
 205     ViewShellBase* mpCurrentViewShellBase;
 206     ViewShellBase* mpFullScreenViewShellBase;
 207     FrameView* mpFullScreenFrameView;
 208     ImplSVEvent * mnInPlaceConfigEvent;
 209 };
 210
 211 namespace slideshowhelp
 212 {
 213     void ShowSlideShow(SfxRequest const & rReq, SdDrawDocument &rDoc);
 214 }
 215
 216 }
 217
 218 #endif // INCLUDED_SD_SOURCE_UI_INC_SLIDESHOW_HXX
 219
 220 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */