sdext/source/presenter/PresenterViewFactory.cxx

   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: PresenterViewFactory.cxx,v $
  10  *
  11  * $Revision: 1.6 $
  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 // MARKER(update_precomp.py): autogen include statement, do not remove
  33 #include "precompiled_sdext.hxx"
  34
  35 #include "PresenterViewFactory.hxx"
  36 #include "PresenterPaneContainer.hxx"
  37 #include "PresenterHelper.hxx"
  38 #include "PresenterHelpView.hxx"
  39 #include "PresenterNotesView.hxx"
  40 #include "PresenterSlideShowView.hxx"
  41 #include "PresenterSlidePreview.hxx"
  42 #include "PresenterSlideSorter.hxx"
  43 #include "PresenterToolBar.hxx"
  44 #include <com/sun/star/beans/XPropertySet.hpp>
  45 #include <com/sun/star/drawing/framework/ResourceId.hpp>
  46 #include <com/sun/star/drawing/framework/XControllerManager.hpp>
  47 #include <com/sun/star/drawing/framework/XConfigurationController.hpp>
  48 #include <com/sun/star/drawing/XDrawPages.hpp>
  49 #include <com/sun/star/drawing/XDrawPagesSupplier.hpp>
  50 #include <com/sun/star/drawing/XSlideSorterBase.hpp>
  51 #include <com/sun/star/presentation/XSlideShow.hpp>
  52 #include <com/sun/star/presentation/XSlideShowView.hpp>
  53 #include <cppuhelper/compbase1.hxx>
  54 #include <boost/bind.hpp>
  55
  56 using namespace ::com::sun::star;
  57 using namespace ::com::sun::star::uno;
  58 using namespace ::com::sun::star::drawing::framework;
  59 using ::rtl::OUString;
  60
  61 #define A2S(pString) (::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(pString)))
  62
  63 namespace sdext { namespace presenter {
  64
  65 const ::rtl::OUString PresenterViewFactory::msCurrentSlidePreviewViewURL(
  66     A2S("private:resource/view/Presenter/CurrentSlidePreview"));
  67 const ::rtl::OUString PresenterViewFactory::msNextSlidePreviewViewURL(
  68     A2S("private:resource/view/Presenter/NextSlidePreview"));
  69 const ::rtl::OUString PresenterViewFactory::msNotesViewURL(
  70     A2S("private:resource/view/Presenter/Notes"));
  71 const ::rtl::OUString PresenterViewFactory::msToolBarViewURL(
  72     A2S("private:resource/view/Presenter/ToolBar"));
  73 const ::rtl::OUString PresenterViewFactory::msSlideSorterURL(
  74     A2S("private:resource/view/Presenter/SlideSorter"));
  75 const ::rtl::OUString PresenterViewFactory::msHelpViewURL(
  76     A2S("private:resource/view/Presenter/Help"));
  77
  78
  79
  80 //===== SimpleView ============================================================
  81
  82 namespace {
  83
  84 typedef ::cppu::WeakComponentImplHelper1 <XView> SimpleViewInterfaceBase;
  85
  86 class SimpleView
  87     : private ::cppu::BaseMutex,
  88       public SimpleViewInterfaceBase
  89 {
  90 public:
  91     SimpleView (const Reference<XResourceId>& rxViewId)
  92         : SimpleViewInterfaceBase(m_aMutex),mxResourceId(rxViewId) {};
  93     virtual ~SimpleView (void) {};
  94
  95     // XView
  96
  97     virtual Reference<XResourceId> SAL_CALL getResourceId (void) throw (RuntimeException)
  98     { return mxResourceId; };
  99
 100 private:
 101     Reference<XResourceId> mxResourceId;
 102 };
 103
 104
 105
 106 /** By default the PresenterSlidePreview shows the preview of the current
 107     slide.  This adapter class makes it display the preview of the next
 108     slide.
 109 */
 110 class NextSlidePreview : public PresenterSlidePreview
 111 {
 112 public:
 113     NextSlidePreview (
 114         const css::uno::Reference<css::uno::XComponentContext>& rxContext,
 115         const css::uno::Reference<css::drawing::framework::XResourceId>& rxViewId,
 116         const css::uno::Reference<css::drawing::framework::XPane>& rxAnchorPane,
 117         const ::rtl::Reference<PresenterController>& rpPresenterController)
 118         : PresenterSlidePreview(rxContext, rxViewId, rxAnchorPane, rpPresenterController)
 119     {
 120     }
 121     virtual ~NextSlidePreview (void) {}
 122     virtual void SAL_CALL setCurrentPage (
 123         const css::uno::Reference<css::drawing::XDrawPage>& rxSlide)
 124         throw (css::uno::RuntimeException)
 125     {
 126         Reference<presentation::XSlideShowController> xSlideShowController (
 127             mpPresenterController->GetSlideShowController());
 128         Reference<drawing::XDrawPage> xSlide;
 129         if (xSlideShowController.is())
 130         {
 131             const sal_Int32 nCount (xSlideShowController->getSlideCount());
 132             sal_Int32 nNextSlideIndex (-1);
 133             if (xSlideShowController->getCurrentSlide() == rxSlide)
 134             {
 135                 nNextSlideIndex = xSlideShowController->getNextSlideIndex();
 136             }
 137             else
 138             {
 139                 for (sal_Int32 nIndex=0; nIndex<nCount; ++nIndex)
 140                 {
 141                     if (rxSlide == Reference<drawing::XDrawPage>(
 142                         xSlideShowController->getSlideByIndex(nIndex), UNO_QUERY))
 143                     {
 144                         nNextSlideIndex = nIndex + 1;
 145                     }
 146                 }
 147             }
 148             if (nNextSlideIndex >= 0)
 149             {
 150                 if (nNextSlideIndex < nCount)
 151                 {
 152                     xSlide = Reference<drawing::XDrawPage>(
 153                         xSlideShowController->getSlideByIndex(nNextSlideIndex),
 154                          UNO_QUERY);
 155                 }
 156             }
 157         }
 158         PresenterSlidePreview::setCurrentPage(xSlide);
 159     }
 160 };
 161
 162 } // end of anonymous namespace
 163
 164
 165
 166
 167 //===== PresenterViewFactory ==============================================
 168
 169 PresenterViewFactory::PresenterViewFactory (
 170     const Reference<uno::XComponentContext>& rxContext,
 171     const Reference<frame::XController>& rxController,
 172     const ::rtl::Reference<PresenterController>& rpPresenterController)
 173     : PresenterViewFactoryInterfaceBase(m_aMutex),
 174       mxComponentContext(rxContext),
 175       mxConfigurationController(),
 176       mxControllerWeak(rxController),
 177       mpPresenterController(rpPresenterController),
 178       mpResourceCache()
 179 {
 180 }
 181
 182
 183
 184
 185 Reference<drawing::framework::XResourceFactory> PresenterViewFactory::Create (
 186     const Reference<uno::XComponentContext>& rxContext,
 187     const Reference<frame::XController>& rxController,
 188     const ::rtl::Reference<PresenterController>& rpPresenterController)
 189 {
 190     rtl::Reference<PresenterViewFactory> pFactory (
 191         new PresenterViewFactory(rxContext,rxController,rpPresenterController));
 192     pFactory->Register(rxController);
 193     return Reference<drawing::framework::XResourceFactory>(
 194         static_cast<XWeak*>(pFactory.get()), UNO_QUERY);
 195 }
 196
 197
 198
 199
 200 void PresenterViewFactory::Register (const Reference<frame::XController>& rxController)
 201 {
 202     try
 203     {
 204         // Get the configuration controller.
 205         Reference<XControllerManager> xCM (rxController, UNO_QUERY_THROW);
 206         mxConfigurationController = xCM->getConfigurationController();
 207         if ( ! mxConfigurationController.is())
 208         {
 209             throw RuntimeException();
 210         }
 211         else
 212         {
 213             mxConfigurationController->addResourceFactory(msCurrentSlidePreviewViewURL, this);
 214             mxConfigurationController->addResourceFactory(msNextSlidePreviewViewURL, this);
 215             mxConfigurationController->addResourceFactory(msNotesViewURL, this);
 216             mxConfigurationController->addResourceFactory(msToolBarViewURL, this);
 217             mxConfigurationController->addResourceFactory(msSlideSorterURL, this);
 218             mxConfigurationController->addResourceFactory(msHelpViewURL, this);
 219         }
 220     }
 221     catch (RuntimeException&)
 222     {
 223         OSL_ASSERT(false);
 224         if (mxConfigurationController.is())
 225             mxConfigurationController->removeResourceFactoryForReference(this);
 226         mxConfigurationController = NULL;
 227
 228         throw;
 229     }
 230 }
 231
 232
 233
 234
 235 PresenterViewFactory::~PresenterViewFactory (void)
 236 {
 237 }
 238
 239
 240
 241
 242 void SAL_CALL PresenterViewFactory::disposing (void)
 243     throw (RuntimeException)
 244 {
 245     if (mxConfigurationController.is())
 246         mxConfigurationController->removeResourceFactoryForReference(this);
 247     mxConfigurationController = NULL;
 248
 249     if (mpResourceCache.get() != NULL)
 250     {
 251         // Dispose all views in the cache.
 252         ResourceContainer::const_iterator iView (mpResourceCache->begin());
 253         ResourceContainer::const_iterator iEnd (mpResourceCache->end());
 254         for ( ; iView!=iEnd; ++iView)
 255         {
 256             try
 257             {
 258                 Reference<lang::XComponent> xComponent (iView->second.first, UNO_QUERY);
 259                 if (xComponent.is())
 260                     xComponent->dispose();
 261             }
 262             catch (lang::DisposedException&)
 263             {
 264             }
 265         }
 266         mpResourceCache.reset();
 267     }
 268 }
 269
 270
 271
 272
 273 //----- XViewFactory ----------------------------------------------------------
 274
 275 Reference<XResource> SAL_CALL PresenterViewFactory::createResource (
 276     const Reference<XResourceId>& rxViewId)
 277     throw (RuntimeException)
 278 {
 279     ThrowIfDisposed();
 280
 281     Reference<XResource> xView;
 282
 283     if (rxViewId.is())
 284     {
 285         Reference<XPane> xAnchorPane (
 286             mxConfigurationController->getResource(rxViewId->getAnchor()),
 287             UNO_QUERY_THROW);
 288         xView = GetViewFromCache(rxViewId, xAnchorPane);
 289         if (xView == NULL)
 290             xView = CreateView(rxViewId, xAnchorPane);
 291
 292         // Activate the view.
 293         PresenterPaneContainer::SharedPaneDescriptor pDescriptor (
 294             mpPresenterController->GetPaneContainer()->FindPaneId(rxViewId->getAnchor()));
 295         if (pDescriptor.get() != NULL)
 296             pDescriptor->SetActivationState(true);
 297     }
 298
 299     return xView;
 300 }
 301
 302
 303
 304
 305 void SAL_CALL PresenterViewFactory::releaseResource (const Reference<XResource>& rxView)
 306     throw (RuntimeException)
 307 {
 308     ThrowIfDisposed();
 309
 310     if ( ! rxView.is())
 311         return;
 312
 313     // Deactivate the view.
 314     PresenterPaneContainer::SharedPaneDescriptor pDescriptor (
 315         mpPresenterController->GetPaneContainer()->FindPaneId(
 316             rxView->getResourceId()->getAnchor()));
 317     if (pDescriptor.get() != NULL)
 318         pDescriptor->SetActivationState(false);
 319
 320     // Dispose only views that we can not put into the cache.
 321     CachablePresenterView* pView = dynamic_cast<CachablePresenterView*>(rxView.get());
 322     if (pView == NULL || mpResourceCache.get()==NULL)
 323     {
 324         try
 325         {
 326             if (pView != NULL)
 327                 pView->ReleaseView();
 328             Reference<lang::XComponent> xComponent (rxView, UNO_QUERY);
 329             if (xComponent.is())
 330                 xComponent->dispose();
 331         }
 332         catch (lang::DisposedException&)
 333         {
 334             // Do not let disposed exceptions get out.  It might be interpreted
 335             // as coming from the factory, which would then be removed from the
 336             // drawing framework.
 337         }
 338     }
 339     else
 340     {
 341         // Put cachable views in the cache.
 342         Reference<XResourceId> xViewId (rxView->getResourceId());
 343         if (xViewId.is())
 344         {
 345             Reference<XPane> xAnchorPane (
 346                 mxConfigurationController->getResource(xViewId->getAnchor()),
 347                 UNO_QUERY_THROW);
 348             (*mpResourceCache)[xViewId->getResourceURL()]
 349                 = ViewResourceDescriptor(Reference<XView>(rxView, UNO_QUERY), xAnchorPane);
 350             pView->DeactivatePresenterView();
 351         }
 352     }
 353 }
 354
 355
 356
 357
 358 //-----------------------------------------------------------------------------
 359
 360 Reference<XResource> PresenterViewFactory::GetViewFromCache(
 361     const Reference<XResourceId>& rxViewId,
 362     const Reference<XPane>& rxAnchorPane) const
 363 {
 364     if (mpResourceCache.get() == NULL)
 365         return NULL;
 366
 367     try
 368     {
 369         const OUString sResourceURL (rxViewId->getResourceURL());
 370
 371         // Can we use a view from the cache?
 372         ResourceContainer::const_iterator iView (mpResourceCache->find(sResourceURL));
 373         if (iView != mpResourceCache->end())
 374         {
 375             // The view is in the container but it can only be used if
 376             // the anchor pane is the same now as it was at creation of
 377             // the view.
 378             if (iView->second.second == rxAnchorPane)
 379             {
 380                 CachablePresenterView* pView
 381                     = dynamic_cast<CachablePresenterView*>(iView->second.first.get());
 382                 if (pView != NULL)
 383                     pView->ActivatePresenterView();
 384                 return Reference<XResource>(iView->second.first, UNO_QUERY);
 385             }
 386
 387             // Right view, wrong pane.  Create a new view.
 388         }
 389     }
 390     catch (RuntimeException&)
 391     {
 392     }
 393     return NULL;
 394 }
 395
 396
 397
 398
 399 Reference<XResource> PresenterViewFactory::CreateView(
 400     const Reference<XResourceId>& rxViewId,
 401     const Reference<XPane>& rxAnchorPane)
 402 {
 403     Reference<XView> xView;
 404
 405     try
 406     {
 407         const OUString sResourceURL (rxViewId->getResourceURL());
 408
 409         if (sResourceURL.equals(msCurrentSlidePreviewViewURL))
 410         {
 411             xView = CreateSlideShowView(rxViewId);
 412         }
 413         else if (sResourceURL.equals(msNotesViewURL))
 414         {
 415             xView = CreateNotesView(rxViewId, rxAnchorPane);
 416         }
 417         else if (sResourceURL.equals(msNextSlidePreviewViewURL))
 418         {
 419             xView = CreateSlidePreviewView(rxViewId, rxAnchorPane);
 420         }
 421         else if (sResourceURL.equals(msToolBarViewURL))
 422         {
 423             xView = CreateToolBarView(rxViewId);
 424         }
 425         else if (sResourceURL.equals(msSlideSorterURL))
 426         {
 427             xView = CreateSlideSorterView(rxViewId);
 428         }
 429         else if (sResourceURL.equals(msHelpViewURL))
 430         {
 431             xView = CreateHelpView(rxViewId);
 432         }
 433
 434         // Activate it.
 435         CachablePresenterView* pView = dynamic_cast<CachablePresenterView*>(xView.get());
 436         if (pView != NULL)
 437             pView->ActivatePresenterView();
 438     }
 439     catch (RuntimeException&)
 440     {
 441         xView = NULL;
 442     }
 443
 444     return Reference<XResource>(xView, UNO_QUERY);
 445 }
 446
 447
 448
 449
 450 Reference<XView> PresenterViewFactory::CreateSlideShowView(
 451     const Reference<XResourceId>& rxViewId) const
 452 {
 453     Reference<XView> xView;
 454
 455     if ( ! mxConfigurationController.is())
 456         return xView;
 457     if ( ! mxComponentContext.is())
 458         return xView;
 459
 460     try
 461     {
 462         rtl::Reference<PresenterSlideShowView> pShowView (
 463             new PresenterSlideShowView(
 464                 mxComponentContext,
 465                 rxViewId,
 466                 Reference<frame::XController>(mxControllerWeak),
 467                 mpPresenterController));
 468         pShowView->LateInit();
 469         xView = Reference<XView>(pShowView.get());
 470     }
 471     catch (RuntimeException&)
 472     {
 473         xView = NULL;
 474     }
 475
 476     return xView;
 477 }
 478
 479
 480
 481
 482 Reference<XView> PresenterViewFactory::CreateSlidePreviewView(
 483     const Reference<XResourceId>& rxViewId,
 484     const Reference<XPane>& rxAnchorPane) const
 485 {
 486     Reference<XView> xView;
 487
 488     if ( ! mxConfigurationController.is())
 489         return xView;
 490     if ( ! mxComponentContext.is())
 491         return xView;
 492
 493     try
 494     {
 495         xView = Reference<XView>(
 496             static_cast<XWeak*>(new NextSlidePreview(
 497                 mxComponentContext,
 498                 rxViewId,
 499                 rxAnchorPane,
 500                 mpPresenterController)),
 501             UNO_QUERY_THROW);
 502     }
 503     catch (RuntimeException&)
 504     {
 505         xView = NULL;
 506     }
 507
 508     return xView;
 509 }
 510
 511
 512
 513
 514 Reference<XView> PresenterViewFactory::CreateToolBarView(
 515     const Reference<XResourceId>& rxViewId) const
 516 {
 517     return new PresenterToolBarView(
 518         mxComponentContext,
 519         rxViewId,
 520         Reference<frame::XController>(mxControllerWeak),
 521         mpPresenterController);
 522 }
 523
 524
 525
 526
 527 Reference<XView> PresenterViewFactory::CreateNotesView(
 528     const Reference<XResourceId>& rxViewId,
 529     const Reference<XPane>& rxAnchorPane) const
 530 {
 531     (void)rxAnchorPane;
 532     Reference<XView> xView;
 533
 534     if ( ! mxConfigurationController.is())
 535         return xView;
 536     if ( ! mxComponentContext.is())
 537         return xView;
 538
 539     try
 540     {
 541         xView = Reference<XView>(static_cast<XWeak*>(
 542             new PresenterNotesView(
 543                 mxComponentContext,
 544                 rxViewId,
 545                 Reference<frame::XController>(mxControllerWeak),
 546                 mpPresenterController)),
 547             UNO_QUERY_THROW);
 548     }
 549     catch (RuntimeException&)
 550     {
 551         xView = NULL;
 552     }
 553
 554     return xView;
 555 }
 556
 557
 558
 559
 560 Reference<XView> PresenterViewFactory::CreateSlideSorterView(
 561     const Reference<XResourceId>& rxViewId) const
 562 {
 563     Reference<XView> xView;
 564
 565     if ( ! mxConfigurationController.is())
 566         return xView;
 567     if ( ! mxComponentContext.is())
 568         return xView;
 569
 570     try
 571     {
 572         rtl::Reference<PresenterSlideSorter> pView (
 573             new PresenterSlideSorter(
 574                 mxComponentContext,
 575                 rxViewId,
 576                 Reference<frame::XController>(mxControllerWeak),
 577                 mpPresenterController));
 578         PresenterPaneContainer::SharedPaneDescriptor pDescriptor (
 579             mpPresenterController->GetPaneContainer()->FindPaneId(rxViewId->getAnchor()));
 580         if (pDescriptor.get() != NULL)
 581             pDescriptor->maActivator = ::boost::bind(
 582                 &PresenterSlideSorter::SetActiveState, pView.get(), _1);
 583         xView = pView.get();
 584     }
 585     catch (RuntimeException&)
 586     {
 587         xView = NULL;
 588     }
 589
 590     return xView;
 591 }
 592
 593
 594
 595
 596 Reference<XView> PresenterViewFactory::CreateHelpView(
 597     const Reference<XResourceId>& rxViewId) const
 598 {
 599     return Reference<XView>(new PresenterHelpView(
 600         mxComponentContext,
 601         rxViewId,
 602         Reference<frame::XController>(mxControllerWeak),
 603         mpPresenterController));
 604 }
 605
 606
 607
 608
 609
 610 void PresenterViewFactory::ThrowIfDisposed (void) const
 611     throw (::com::sun::star::lang::DisposedException)
 612 {
 613     if (rBHelper.bDisposed || rBHelper.bInDispose)
 614     {
 615         throw lang::DisposedException (
 616             OUString(RTL_CONSTASCII_USTRINGPARAM(
 617                 "PresenterViewFactory object has already been disposed")),
 618             const_cast<uno::XWeak*>(static_cast<const uno::XWeak*>(this)));
 619     }
 620 }
 621
 622
 623
 624
 625 //===== CachablePresenterView =================================================
 626
 627 CachablePresenterView::CachablePresenterView (void)
 628     : mbIsPresenterViewActive(true)
 629 {
 630 }
 631
 632
 633
 634
 635 void CachablePresenterView::ActivatePresenterView (void)
 636 {
 637     mbIsPresenterViewActive = true;
 638 }
 639
 640
 641
 642
 643 void CachablePresenterView::DeactivatePresenterView (void)
 644 {
 645     mbIsPresenterViewActive = false;
 646 }
 647
 648
 649
 650
 651 void CachablePresenterView::ReleaseView (void)
 652 {
 653 }
 654
 655
 656
 657 } }