sd/source/ui/tools/EventMultiplexer.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 #include <EventMultiplexer.hxx>
  21
  22 #include <MutexOwner.hxx>
  23 #include <ViewShellBase.hxx>
  24 #include <drawdoc.hxx>
  25 #include <DrawController.hxx>
  26 #include <SlideSorterViewShell.hxx>
  27 #include <framework/FrameworkHelper.hxx>
  28 #include <sal/log.hxx>
  29 #include <tools/debug.hxx>
  30
  31 #include <com/sun/star/beans/XPropertySet.hpp>
  32 #include <com/sun/star/frame/XFrame.hpp>
  33 #include <com/sun/star/lang/DisposedException.hpp>
  34 #include <com/sun/star/drawing/framework/XConfigurationChangeListener.hpp>
  35 #include <com/sun/star/drawing/framework/XView.hpp>
  36 #include <cppuhelper/compbase.hxx>
  37 #include <sfx2/viewfrm.hxx>
  38
  39 using namespace ::com::sun::star;
  40 using namespace ::com::sun::star::lang;
  41 using namespace ::com::sun::star::uno;
  42 using namespace ::com::sun::star::drawing::framework;
  43
  44 using ::sd::framework::FrameworkHelper;
  45
  46 class SdDrawDocument;
  47
  48 namespace {
  49 const sal_Int32 ResourceActivationEvent = 0;
  50 const sal_Int32 ResourceDeactivationEvent = 1;
  51 const sal_Int32 ConfigurationUpdateEvent = 2;
  52 }
  53
  54 namespace sd::tools {
  55
  56 typedef cppu::WeakComponentImplHelper<
  57       css::beans::XPropertyChangeListener,
  58       css::frame::XFrameActionListener,
  59       css::view::XSelectionChangeListener,
  60       css::drawing::framework::XConfigurationChangeListener
  61     > EventMultiplexerImplementationInterfaceBase;
  62
  63 class EventMultiplexer::Implementation
  64     : protected MutexOwner,
  65       public EventMultiplexerImplementationInterfaceBase,
  66       public SfxListener
  67 {
  68 public:
  69     explicit Implementation (ViewShellBase& rBase);
  70     virtual ~Implementation() override;
  71
  72     void AddEventListener (
  73         const Link<EventMultiplexerEvent&,void>& rCallback);
  74
  75     void RemoveEventListener (
  76         const Link<EventMultiplexerEvent&,void>& rCallback);
  77
  78     void CallListeners (EventMultiplexerEvent& rEvent);
  79
  80     //===== lang::XEventListener ==============================================
  81     virtual void SAL_CALL
  82         disposing (const css::lang::EventObject& rEventObject) override;
  83
  84     //===== beans::XPropertySetListener =======================================
  85     virtual void SAL_CALL
  86         propertyChange (
  87             const css::beans::PropertyChangeEvent& rEvent) override;
  88
  89     //===== view::XSelectionChangeListener ====================================
  90     virtual void SAL_CALL
  91         selectionChanged (
  92             const css::lang::EventObject& rEvent) override;
  93
  94     //===== frame::XFrameActionListener  ======================================
  95     /** For certain actions the listener connects to a new controller of the
  96         frame it is listening to.  This usually happens when the view shell
  97         in the center pane is replaced by another view shell.
  98     */
  99     virtual void SAL_CALL
 100         frameAction (const css::frame::FrameActionEvent& rEvent) override;
 101
 102     //===== drawing::framework::XConfigurationChangeListener ==================
 103     virtual void SAL_CALL
 104         notifyConfigurationChange (
 105             const css::drawing::framework::ConfigurationChangeEvent& rEvent) override;
 106
 107     virtual void SAL_CALL disposing() override;
 108
 109 protected:
 110     virtual void Notify (
 111         SfxBroadcaster& rBroadcaster,
 112         const SfxHint& rHint) override;
 113
 114 private:
 115     ViewShellBase& mrBase;
 116     typedef ::std::vector<Link<EventMultiplexerEvent&,void>> ListenerList;
 117     ListenerList maListeners;
 118
 119     /// Remember whether we are listening to the UNO controller.
 120     bool mbListeningToController;
 121     /// Remember whether we are listening to the frame.
 122     bool mbListeningToFrame;
 123
 124     css::uno::WeakReference<css::frame::XController> mxControllerWeak;
 125     css::uno::WeakReference<css::frame::XFrame> mxFrameWeak;
 126     SdDrawDocument* mpDocument;
 127     css::uno::WeakReference<css::drawing::framework::XConfigurationController>
 128          mxConfigurationControllerWeak;
 129
 130     void ReleaseListeners();
 131
 132     void ConnectToController();
 133     void DisconnectFromController();
 134
 135     void CallListeners (
 136         EventMultiplexerEventId eId,
 137         void const * pUserData = nullptr);
 138
 139     DECL_LINK(SlideSorterSelectionChangeListener, LinkParamNone*, void);
 140 };
 141
 142 const char aCurrentPagePropertyName[] = "CurrentPage";
 143 const char aEditModePropertyName[] = "IsMasterPageMode";
 144
 145 //===== EventMultiplexer ======================================================
 146
 147 EventMultiplexer::EventMultiplexer (ViewShellBase& rBase)
 148     : mpImpl (new EventMultiplexer::Implementation(rBase))
 149 {
 150 }
 151
 152 EventMultiplexer::~EventMultiplexer()
 153 {
 154     try
 155     {
 156         mpImpl->dispose();
 157     }
 158     catch (const RuntimeException&)
 159     {
 160     }
 161     catch (const Exception&)
 162     {
 163     }
 164 }
 165
 166 void EventMultiplexer::AddEventListener (
 167     const Link<EventMultiplexerEvent&,void>& rCallback)
 168 {
 169     mpImpl->AddEventListener(rCallback);
 170 }
 171
 172 void EventMultiplexer::RemoveEventListener (
 173     const Link<EventMultiplexerEvent&,void>& rCallback)
 174 {
 175     mpImpl->RemoveEventListener(rCallback);
 176 }
 177
 178 void EventMultiplexer::MultiplexEvent(
 179     EventMultiplexerEventId eEventId,
 180     void const * pUserData )
 181 {
 182     EventMultiplexerEvent aEvent(eEventId, pUserData);
 183     mpImpl->CallListeners(aEvent);
 184 }
 185
 186 //===== EventMultiplexer::Implementation ======================================
 187
 188 EventMultiplexer::Implementation::Implementation (ViewShellBase& rBase)
 189     : MutexOwner(),
 190       EventMultiplexerImplementationInterfaceBase(maMutex),
 191       SfxListener(),
 192       mrBase (rBase),
 193       mbListeningToController (false),
 194       mbListeningToFrame (false),
 195       mxControllerWeak(nullptr),
 196       mxFrameWeak(nullptr),
 197       mpDocument(nullptr),
 198       mxConfigurationControllerWeak()
 199 {
 200     // Connect to the frame to listen for controllers being exchanged.
 201     // Listen to changes of certain properties.
 202     Reference<frame::XFrame> xFrame =
 203         mrBase.GetFrame()->GetFrame().GetFrameInterface();
 204     mxFrameWeak = xFrame;
 205     if (xFrame.is())
 206     {
 207         xFrame->addFrameActionListener (
 208             Reference<frame::XFrameActionListener>(
 209                static_cast<XWeak*>(this), UNO_QUERY));
 210         mbListeningToFrame = true;
 211     }
 212
 213     // Connect to the current controller.
 214     ConnectToController ();
 215
 216     // Listen for document changes.
 217     mpDocument = mrBase.GetDocument();
 218     if (mpDocument != nullptr)
 219         StartListening (*mpDocument);
 220
 221     // Listen for configuration changes.
 222     Reference<XControllerManager> xControllerManager (
 223         Reference<XWeak>(&mrBase.GetDrawController()), UNO_QUERY);
 224     if (!xControllerManager.is())
 225         return;
 226
 227     Reference<XConfigurationController> xConfigurationController (
 228         xControllerManager->getConfigurationController());
 229     mxConfigurationControllerWeak = xConfigurationController;
 230     if (!xConfigurationController.is())
 231         return;
 232
 233     Reference<XComponent> xComponent (xConfigurationController, UNO_QUERY);
 234     if (xComponent.is())
 235         xComponent->addEventListener(static_cast<beans::XPropertyChangeListener*>(this));
 236
 237     xConfigurationController->addConfigurationChangeListener(
 238         this,
 239         FrameworkHelper::msResourceActivationEvent,
 240         makeAny(ResourceActivationEvent));
 241     xConfigurationController->addConfigurationChangeListener(
 242         this,
 243         FrameworkHelper::msResourceDeactivationEvent,
 244         makeAny(ResourceDeactivationEvent));
 245     xConfigurationController->addConfigurationChangeListener(
 246         this,
 247         FrameworkHelper::msConfigurationUpdateEndEvent,
 248         makeAny(ConfigurationUpdateEvent));
 249 }
 250
 251 EventMultiplexer::Implementation::~Implementation()
 252 {
 253     DBG_ASSERT( !mbListeningToFrame,
 254         "sd::EventMultiplexer::Implementation::~Implementation(), disposing was not called!" );
 255 }
 256
 257 void EventMultiplexer::Implementation::ReleaseListeners()
 258 {
 259     if (mbListeningToFrame)
 260     {
 261         mbListeningToFrame = false;
 262
 263         // Stop listening for changes of certain properties.
 264         Reference<frame::XFrame> xFrame (mxFrameWeak);
 265         if (xFrame.is())
 266         {
 267             xFrame->removeFrameActionListener (
 268                 Reference<frame::XFrameActionListener>(
 269                     static_cast<XWeak*>(this), UNO_QUERY));
 270         }
 271     }
 272
 273     DisconnectFromController ();
 274
 275     if (mpDocument != nullptr)
 276     {
 277         EndListening (*mpDocument);
 278         mpDocument = nullptr;
 279     }
 280
 281     // Stop listening for configuration changes.
 282     Reference<XConfigurationController> xConfigurationController (mxConfigurationControllerWeak);
 283     if (xConfigurationController.is())
 284     {
 285         Reference<XComponent> xComponent (xConfigurationController, UNO_QUERY);
 286         if (xComponent.is())
 287             xComponent->removeEventListener(static_cast<beans::XPropertyChangeListener*>(this));
 288
 289         xConfigurationController->removeConfigurationChangeListener(this);
 290     }
 291 }
 292
 293 void EventMultiplexer::Implementation::AddEventListener (
 294     const Link<EventMultiplexerEvent&,void>& rCallback)
 295 {
 296     for (auto const & i : maListeners)
 297         if (i == rCallback)
 298             return;
 299     maListeners.push_back(rCallback);
 300 }
 301
 302 void EventMultiplexer::Implementation::RemoveEventListener (
 303     const Link<EventMultiplexerEvent&,void>& rCallback)
 304 {
 305     auto iListener = std::find(maListeners.begin(), maListeners.end(), rCallback);
 306     if (iListener != maListeners.end())
 307         maListeners.erase(iListener);
 308 }
 309
 310 void EventMultiplexer::Implementation::ConnectToController()
 311 {
 312     // Just in case that we missed some event we now disconnect from the old
 313     // controller.
 314     DisconnectFromController ();
 315
 316     // Register at the controller of the main view shell.
 317
 318     // We have to store a (weak) reference to the controller so that we can
 319     // unregister without having to ask the mrBase member (which at that
 320     // time may be destroyed.)
 321     Reference<frame::XController> xController = mrBase.GetController();
 322     mxControllerWeak = mrBase.GetController();
 323
 324     try
 325     {
 326         // Listen for disposing events.
 327         if (xController.is())
 328         {
 329             xController->addEventListener (
 330                 Reference<lang::XEventListener>(
 331                     static_cast<XWeak*>(this), UNO_QUERY));
 332             mbListeningToController = true;
 333         }
 334
 335         // Listen to changes of certain properties.
 336         Reference<beans::XPropertySet> xSet (xController, UNO_QUERY);
 337         if (xSet.is())
 338         {
 339                 try
 340                 {
 341                     xSet->addPropertyChangeListener(aCurrentPagePropertyName, this);
 342                 }
 343                 catch (const beans::UnknownPropertyException&)
 344                 {
 345                     SAL_WARN("sd", "EventMultiplexer::ConnectToController: CurrentPage unknown");
 346                 }
 347
 348                 try
 349                 {
 350                     xSet->addPropertyChangeListener(aEditModePropertyName, this);
 351                 }
 352                 catch (const beans::UnknownPropertyException&)
 353                 {
 354                     SAL_WARN("sd", "EventMultiplexer::ConnectToController: IsMasterPageMode unknown");
 355                 }
 356         }
 357
 358         // Listen for selection change events.
 359         Reference<view::XSelectionSupplier> xSelection (xController, UNO_QUERY);
 360         if (xSelection.is())
 361         {
 362             xSelection->addSelectionChangeListener(this);
 363         }
 364     }
 365     catch (const lang::DisposedException&)
 366     {
 367         mbListeningToController = false;
 368     }
 369 }
 370
 371 void EventMultiplexer::Implementation::DisconnectFromController()
 372 {
 373     if (!mbListeningToController)
 374         return;
 375
 376     mbListeningToController = false;
 377
 378     Reference<frame::XController> xController = mxControllerWeak;
 379
 380     Reference<beans::XPropertySet> xSet (xController, UNO_QUERY);
 381     // Remove the property listener.
 382     if (xSet.is())
 383     {
 384         try
 385         {
 386             xSet->removePropertyChangeListener(aCurrentPagePropertyName, this);
 387         }
 388         catch (const beans::UnknownPropertyException&)
 389         {
 390             SAL_WARN("sd", "DisconnectFromController: CurrentPage unknown");
 391         }
 392
 393         try
 394         {
 395             xSet->removePropertyChangeListener(aEditModePropertyName, this);
 396         }
 397         catch (const beans::UnknownPropertyException&)
 398         {
 399             SAL_WARN("sd", "DisconnectFromController: IsMasterPageMode unknown");
 400         }
 401     }
 402
 403     // Remove selection change listener.
 404     Reference<view::XSelectionSupplier> xSelection (xController, UNO_QUERY);
 405     if (xSelection.is())
 406     {
 407         xSelection->removeSelectionChangeListener(this);
 408     }
 409
 410     // Remove listener for disposing events.
 411     if (xController.is())
 412     {
 413         xController->removeEventListener (
 414             Reference<lang::XEventListener>(static_cast<XWeak*>(this), UNO_QUERY));
 415     }
 416 }
 417
 418 //=====  lang::XEventListener  ================================================
 419
 420 void SAL_CALL EventMultiplexer::Implementation::disposing (
 421     const lang::EventObject& rEventObject)
 422 {
 423     if (mbListeningToController)
 424     {
 425         Reference<frame::XController> xController (mxControllerWeak);
 426         if (rEventObject.Source == xController)
 427         {
 428             mbListeningToController = false;
 429         }
 430     }
 431
 432     Reference<XConfigurationController> xConfigurationController (
 433         mxConfigurationControllerWeak);
 434     if (xConfigurationController.is()
 435         && rEventObject.Source == xConfigurationController)
 436     {
 437         mxConfigurationControllerWeak.clear();
 438     }
 439 }
 440
 441 //=====  beans::XPropertySetListener  =========================================
 442
 443 void SAL_CALL EventMultiplexer::Implementation::propertyChange (
 444     const beans::PropertyChangeEvent& rEvent)
 445 {
 446     if (rBHelper.bDisposed || rBHelper.bInDispose)
 447     {
 448         throw lang::DisposedException (
 449             "SlideSorterController object has already been disposed",
 450             static_cast<uno::XWeak*>(this));
 451     }
 452
 453     if ( rEvent.PropertyName == aCurrentPagePropertyName )
 454     {
 455         CallListeners(EventMultiplexerEventId::CurrentPageChanged);
 456     }
 457     else if ( rEvent.PropertyName == aEditModePropertyName )
 458     {
 459         bool bIsMasterPageMode (false);
 460         rEvent.NewValue >>= bIsMasterPageMode;
 461         if (bIsMasterPageMode)
 462             CallListeners(EventMultiplexerEventId::EditModeMaster);
 463         else
 464             CallListeners(EventMultiplexerEventId::EditModeNormal);
 465     }
 466 }
 467
 468 //===== frame::XFrameActionListener  ==========================================
 469
 470 void SAL_CALL EventMultiplexer::Implementation::frameAction (
 471     const frame::FrameActionEvent& rEvent)
 472 {
 473     Reference<frame::XFrame> xFrame (mxFrameWeak);
 474     if (rEvent.Frame != xFrame)
 475         return;
 476
 477     switch (rEvent.Action)
 478     {
 479         case frame::FrameAction_COMPONENT_DETACHING:
 480             DisconnectFromController();
 481             CallListeners (EventMultiplexerEventId::ControllerDetached);
 482             break;
 483
 484         case frame::FrameAction_COMPONENT_REATTACHED:
 485             CallListeners (EventMultiplexerEventId::ControllerDetached);
 486             DisconnectFromController();
 487             ConnectToController();
 488             CallListeners (EventMultiplexerEventId::ControllerAttached);
 489             break;
 490
 491         case frame::FrameAction_COMPONENT_ATTACHED:
 492             ConnectToController();
 493             CallListeners (EventMultiplexerEventId::ControllerAttached);
 494             break;
 495
 496         default:
 497             break;
 498     }
 499 }
 500
 501 //===== view::XSelectionChangeListener ========================================
 502
 503 void SAL_CALL EventMultiplexer::Implementation::selectionChanged (
 504     const lang::EventObject& )
 505 {
 506     CallListeners (EventMultiplexerEventId::EditViewSelection);
 507 }
 508
 509 //===== drawing::framework::XConfigurationChangeListener ==================
 510
 511 void SAL_CALL EventMultiplexer::Implementation::notifyConfigurationChange (
 512     const ConfigurationChangeEvent& rEvent)
 513 {
 514     sal_Int32 nEventType = 0;
 515     rEvent.UserData >>= nEventType;
 516     switch (nEventType)
 517     {
 518         case ResourceActivationEvent:
 519             if (rEvent.ResourceId->getResourceURL().match(FrameworkHelper::msViewURLPrefix))
 520             {
 521                 CallListeners (EventMultiplexerEventId::ViewAdded);
 522
 523                 if (rEvent.ResourceId->isBoundToURL(
 524                     FrameworkHelper::msCenterPaneURL, AnchorBindingMode_DIRECT))
 525                 {
 526                     CallListeners (EventMultiplexerEventId::MainViewAdded);
 527                 }
 528
 529                 // Add selection change listener at slide sorter.
 530                 if (rEvent.ResourceId->getResourceURL() == FrameworkHelper::msSlideSorterURL)
 531                 {
 532                     slidesorter::SlideSorterViewShell* pViewShell
 533                         = dynamic_cast<slidesorter::SlideSorterViewShell*>(
 534                             FrameworkHelper::GetViewShell(
 535                                 Reference<XView>(rEvent.ResourceObject,UNO_QUERY)).get());
 536                     if (pViewShell != nullptr)
 537                         pViewShell->AddSelectionChangeListener (
 538                             LINK(this,
 539                                 EventMultiplexer::Implementation,
 540                                 SlideSorterSelectionChangeListener));
 541                 }
 542             }
 543             break;
 544
 545         case ResourceDeactivationEvent:
 546             if (rEvent.ResourceId->getResourceURL().match(FrameworkHelper::msViewURLPrefix))
 547             {
 548                 if (rEvent.ResourceId->isBoundToURL(
 549                     FrameworkHelper::msCenterPaneURL, AnchorBindingMode_DIRECT))
 550                 {
 551                     CallListeners (EventMultiplexerEventId::MainViewRemoved);
 552                 }
 553
 554                 // Remove selection change listener from slide sorter.  Add
 555                 // selection change listener at slide sorter.
 556                 if (rEvent.ResourceId->getResourceURL() == FrameworkHelper::msSlideSorterURL)
 557                 {
 558                     slidesorter::SlideSorterViewShell* pViewShell
 559                         = dynamic_cast<slidesorter::SlideSorterViewShell*>(
 560                             FrameworkHelper::GetViewShell(
 561                                 Reference<XView>(rEvent.ResourceObject, UNO_QUERY)).get());
 562                     if (pViewShell != nullptr)
 563                         pViewShell->RemoveSelectionChangeListener (
 564                             LINK(this,
 565                                 EventMultiplexer::Implementation,
 566                                 SlideSorterSelectionChangeListener));
 567                 }
 568             }
 569             break;
 570
 571         case ConfigurationUpdateEvent:
 572             CallListeners (EventMultiplexerEventId::ConfigurationUpdated);
 573             break;
 574     }
 575
 576 }
 577
 578 void SAL_CALL EventMultiplexer::Implementation::disposing()
 579 {
 580     CallListeners (EventMultiplexerEventId::Disposing);
 581     ReleaseListeners();
 582 }
 583
 584 void EventMultiplexer::Implementation::Notify (
 585     SfxBroadcaster&,
 586     const SfxHint& rHint)
 587 {
 588     if (rHint.GetId() == SfxHintId::ThisIsAnSdrHint)
 589     {
 590         const SdrHint* pSdrHint = static_cast<const SdrHint*>(&rHint);
 591         switch (pSdrHint->GetKind())
 592         {
 593             case SdrHintKind::ModelCleared:
 594             case SdrHintKind::PageOrderChange:
 595                 CallListeners (EventMultiplexerEventId::PageOrder);
 596                 break;
 597
 598             case SdrHintKind::SwitchToPage:
 599                 CallListeners (EventMultiplexerEventId::CurrentPageChanged);
 600                 break;
 601
 602             case SdrHintKind::ObjectChange:
 603                 CallListeners(EventMultiplexerEventId::ShapeChanged,
 604                     static_cast<const void*>(pSdrHint->GetPage()));
 605                 break;
 606
 607             case SdrHintKind::ObjectInserted:
 608                 CallListeners(EventMultiplexerEventId::ShapeInserted,
 609                     static_cast<const void*>(pSdrHint->GetPage()));
 610                 break;
 611
 612             case SdrHintKind::ObjectRemoved:
 613                 CallListeners(EventMultiplexerEventId::ShapeRemoved,
 614                     static_cast<const void*>(pSdrHint->GetPage()));
 615                 break;
 616             default:
 617                 break;
 618         }
 619     }
 620     else
 621     {
 622         if (rHint.GetId() == SfxHintId::Dying)
 623             mpDocument = nullptr;
 624     }
 625 }
 626
 627 void EventMultiplexer::Implementation::CallListeners (
 628     EventMultiplexerEventId eId,
 629     void const * pUserData)
 630 {
 631     EventMultiplexerEvent aEvent(eId, pUserData);
 632     CallListeners(aEvent);
 633 }
 634
 635 void EventMultiplexer::Implementation::CallListeners (EventMultiplexerEvent& rEvent)
 636 {
 637     ListenerList aCopyListeners( maListeners );
 638     for (const auto& rListener : aCopyListeners)
 639     {
 640         rListener.Call(rEvent);
 641     }
 642 }
 643
 644 IMPL_LINK_NOARG(EventMultiplexer::Implementation, SlideSorterSelectionChangeListener, LinkParamNone*, void)
 645 {
 646     CallListeners(EventMultiplexerEventId::SlideSortedSelection);
 647 }
 648
 649 //===== EventMultiplexerEvent =================================================
 650
 651 EventMultiplexerEvent::EventMultiplexerEvent (
 652     EventMultiplexerEventId eEventId,
 653     const void* pUserData)
 654     : meEventId(eEventId),
 655       mpUserData(pUserData)
 656 {
 657 }
 658
 659 } // end of namespace ::sd::tools
 660
 661 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */