sdext/source/presenter/PresenterScreen.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: PresenterScreen.hxx,v $
  10  *
  11  * $Revision: 1.4 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31
  32 #ifndef SDEXT_PRESENTER_PRESENTER_SCREEN_HXX
  33 #define SDEXT_PRESENTER_PRESENTER_SCREEN_HXX
  34
  35 #include "PresenterConfigurationAccess.hxx"
  36 #include "PresenterPaneContainer.hxx"
  37 #include <cppuhelper/compbase1.hxx>
  38 #include <cppuhelper/basemutex.hxx>
  39 #include <com/sun/star/lang/XInitialization.hpp>
  40 #include <com/sun/star/frame/XController.hpp>
  41 #include <com/sun/star/frame/XModel2.hpp>
  42 #include <com/sun/star/task/XJob.hpp>
  43 #include <com/sun/star/document/XEventListener.hpp>
  44 #include <com/sun/star/drawing/framework/XConfigurationController.hpp>
  45 #include <com/sun/star/drawing/framework/XView.hpp>
  46 #include <com/sun/star/presentation/XSlideShowController.hpp>
  47 #include <com/sun/star/presentation/XPresentation2.hpp>
  48 #include <rtl/ref.hxx>
  49 #include <boost/noncopyable.hpp>
  50 #include <boost/shared_ptr.hpp>
  51 #include <boost/scoped_ptr.hpp>
  52
  53 namespace css = ::com::sun::star;
  54
  55 namespace sdext { namespace presenter {
  56
  57 class PresenterWindowManager;
  58 class PresenterController;
  59
  60 namespace {
  61     typedef ::cppu::WeakComponentImplHelper1 <
  62         css::task::XJob
  63         > PresenterScreenJobInterfaceBase;
  64     typedef ::cppu::WeakComponentImplHelper1 <
  65         css::lang::XEventListener
  66         > PresenterScreenInterfaceBase;
  67 }
  68
  69
  70
  71
  72 /** The PresenterScreenJob service is instantiated every time a document is
  73     created or loaded.  In its execute() method it then filters out all
  74     non-Impress documents and creates and registers a new PresenterScreen
  75     object.
  76 */
  77 class PresenterScreenJob
  78     : private ::boost::noncopyable,
  79       private ::cppu::BaseMutex,
  80       public PresenterScreenJobInterfaceBase
  81 {
  82 public:
  83     static ::rtl::OUString getImplementationName_static (void);
  84     static css::uno::Sequence< ::rtl::OUString > getSupportedServiceNames_static (void);
  85     static css::uno::Reference<css::uno::XInterface> Create(
  86         const css::uno::Reference<css::uno::XComponentContext>& rxContext)
  87         SAL_THROW((css::uno::Exception));
  88
  89     virtual void SAL_CALL disposing (void);
  90
  91     // XJob
  92
  93     virtual css::uno::Any SAL_CALL execute(
  94         const css::uno::Sequence<css::beans::NamedValue >& Arguments)
  95         throw (css::lang::IllegalArgumentException,
  96             css::uno::Exception,
  97             css::uno::RuntimeException);
  98
  99 private:
 100     PresenterScreenJob (const css::uno::Reference<css::uno::XComponentContext>& rxContext);
 101     virtual ~PresenterScreenJob (void);
 102
 103     css::uno::Reference<css::uno::XComponentContext> mxComponentContext;
 104 };
 105
 106
 107
 108
 109 /** This is the bootstrap class of the presenter screen.  It is registered
 110     as drawing framework startup service.  That means that every drawing
 111     framework instance creates an instance of this class.
 112
 113     <p>A PresenterScreen object registers itself as listener for drawing
 114     framework configuration changes.  It waits for the full screen marker (a
 115     top level resource) to appear in the current configuration.  When that
 116     happens the actual presenter screen is initialized.  A new
 117     PresenterController is created and takes over the task of controlling
 118     the presenter screen.</p>
 119 */
 120 class PresenterScreen
 121     : private ::boost::noncopyable,
 122       private ::cppu::BaseMutex,
 123       public PresenterScreenInterfaceBase
 124 {
 125 public:
 126     PresenterScreen (
 127         const css::uno::Reference<css::uno::XComponentContext>& rxContext,
 128         const css::uno::Reference<css::frame::XModel2>& rxModel);
 129     virtual ~PresenterScreen (void);
 130
 131     virtual void SAL_CALL disposing (void);
 132
 133     /** Make the presenter screen visible.
 134     */
 135     void InitializePresenterScreen (void);
 136
 137     /** Do not call ShutdownPresenterScreen() directly.  Call
 138         RequestShutdownPresenterScreen() instead.  It will issue an
 139         asynchronous call to ShutdownPresenterScreen() when that is safe.
 140     */
 141     void RequestShutdownPresenterScreen (void);
 142
 143
 144     // XEventListener
 145
 146     virtual void SAL_CALL disposing ( const css::lang::EventObject& rEvent) throw (css::uno::RuntimeException);
 147
 148 private:
 149     css::uno::Reference<css::frame::XModel2 > mxModel;
 150     css::uno::Reference<css::frame::XController> mxController;
 151     css::uno::WeakReference<css::drawing::framework::XConfigurationController>
 152         mxConfigurationControllerWeak;
 153     css::uno::WeakReference<css::uno::XComponentContext> mxContextWeak;
 154     css::uno::WeakReference<css::presentation::XSlideShowController> mxSlideShowControllerWeak;
 155     ::rtl::Reference<PresenterController> mpPresenterController;
 156     css::uno::Reference<css::drawing::framework::XResourceId> mxSlideShowViewId;
 157     css::uno::Reference<css::drawing::framework::XConfiguration> mxSavedConfiguration;
 158     ::rtl::Reference<PresenterPaneContainer> mpPaneContainer;
 159     sal_Int32 mnComponentIndex;
 160     css::uno::Reference<css::drawing::framework::XResourceFactory> mxPaneFactory;
 161     css::uno::Reference<css::drawing::framework::XResourceFactory> mxViewFactory;
 162
 163     class ViewDescriptor
 164     {
 165     public:
 166         ::rtl::OUString msTitle;
 167         bool mbIsOpaque;
 168     };
 169     typedef ::std::map<rtl::OUString,ViewDescriptor> ViewDescriptorContainer;
 170     ViewDescriptorContainer maViewDescriptors;
 171
 172
 173     void ShutdownPresenterScreen (void);
 174
 175     /** Create and initialize the factory for presenter view specific panes.
 176     */
 177     void SetupPaneFactory (
 178         const css::uno::Reference<css::uno::XComponentContext>& rxContext);
 179
 180     /** Create and initialize the factory for presenter view specific views.
 181     */
 182     void SetupViewFactory (
 183         const css::uno::Reference<css::uno::XComponentContext>& rxContext);
 184
 185     /** Read the current layout from the configuration and call
 186         ProcessLayout to bring it on to the screen.
 187     */
 188     void SetupConfiguration (
 189         const css::uno::Reference<css::uno::XComponentContext>& rxContext,
 190         const css::uno::Reference<css::drawing::framework::XResourceId>& rxAnchorId);
 191
 192     /** Read one layout from the configuration and make resource activation
 193         requests to bring it on to the screen.  When one layout references a
 194         parent layout then this method calls itself recursively.
 195     */
 196     void ProcessLayout (
 197         PresenterConfigurationAccess& rConfiguration,
 198         const ::rtl::OUString& rsLayoutName,
 199         const css::uno::Reference<css::uno::XComponentContext>& rxContext,
 200         const css::uno::Reference<css::drawing::framework::XResourceId>& rxAnchorId);
 201
 202     /** Called by ProcessLayout for a single entry of a Layouts
 203         configuration list.
 204     */
 205     void ProcessComponent (
 206         const ::rtl::OUString& rsKey,
 207         const ::std::vector<css::uno::Any>& rValues,
 208         const css::uno::Reference<css::uno::XComponentContext>& rxContext,
 209         const css::uno::Reference<css::drawing::framework::XResourceId>& rxAnchorId);
 210
 211     /** Read the view descriptions from the configuration.
 212     */
 213     void ProcessViewDescriptions (
 214         PresenterConfigurationAccess& rConfiguration);
 215
 216     /** Called by ProcessViewDescriptions for a single entry.
 217     */
 218     void ProcessViewDescription (
 219         const ::rtl::OUString& rsKey,
 220         const ::std::vector<css::uno::Any>& rValues);
 221
 222     void SetupView (
 223         const css::uno::Reference<css::uno::XComponentContext>& rxContext,
 224         const css::uno::Reference<css::drawing::framework::XResourceId>& rxAnchorId,
 225         const ::rtl::OUString& rsPaneURL,
 226         const ::rtl::OUString& rsViewURL,
 227         const PresenterPaneContainer::ViewInitializationFunction& rViewInitialization,
 228         const double nLeft,
 229         const double nTop,
 230         const double nRight,
 231         const double nBottom);
 232
 233     /** Return the screen number on which to display the presenter screen.
 234         @return
 235             Returns -1 when the presenter screen can or shall not be
 236             displayed.
 237     */
 238     sal_Int32 GetScreenNumber (
 239         const css::uno::Reference<css::presentation::XPresentation2>& rxPresentation) const;
 240
 241     /** Create a resource id for the full screen background pane so that it
 242         is displayed on another screen than the full screen presentation.
 243     */
 244     css::uno::Reference<css::drawing::framework::XResourceId> GetMainPaneId (
 245         const css::uno::Reference<css::presentation::XPresentation2>& rxPresentation) const;
 246 };
 247
 248 } }
 249
 250 #endif