sd/source/ui/framework/module/NotesPaneModule.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
   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
  10 #include "NotesPaneModule.hxx"
  11
  12 #include <DrawController.hxx>
  13 #include <DrawViewShell.hxx>
  14 #include <EventMultiplexer.hxx>
  15 #include <ViewShellBase.hxx>
  16 #include <ViewShellManager.hxx>
  17
  18 #include <framework/ConfigurationController.hxx>
  19 #include <framework/FrameworkHelper.hxx>
  20 #include <framework/ViewShellWrapper.hxx>
  21
  22 #include <officecfg/Office/Impress.hxx>
  23
  24 #include <com/sun/star/drawing/framework/XControllerManager.hpp>
  25 #include <com/sun/star/frame/XController.hpp>
  26
  27 using namespace ::com::sun::star;
  28 using namespace ::com::sun::star::uno;
  29 using namespace ::com::sun::star::drawing::framework;
  30
  31 namespace
  32 {
  33 const sal_Int32 ResourceActivationRequestEvent = 0;
  34 const sal_Int32 ResourceDeactivationRequestEvent = 1;
  35 }
  36
  37 namespace sd::framework
  38 {
  39 NotesPaneModule::NotesPaneModule(const rtl::Reference<::sd::DrawController>& rxController)
  40     : mxBottomImpressPaneId(FrameworkHelper::CreateResourceId(
  41           FrameworkHelper::msNotesPanelViewURL, FrameworkHelper::msBottomImpressPaneURL))
  42     , mxMainViewAnchorId(FrameworkHelper::CreateResourceId(FrameworkHelper::msCenterPaneURL))
  43 {
  44     if (!rxController.is())
  45         return;
  46
  47     mpViewShellBase = rxController->GetViewShellBase();
  48
  49     mxConfigurationController = rxController->getConfigurationController();
  50     if (!mxConfigurationController.is())
  51         return;
  52
  53     mxConfigurationController->addConfigurationChangeListener(
  54         this, FrameworkHelper::msResourceActivationRequestEvent,
  55         Any(ResourceActivationRequestEvent));
  56     mxConfigurationController->addConfigurationChangeListener(
  57         this, FrameworkHelper::msResourceDeactivationRequestEvent,
  58         Any(ResourceDeactivationRequestEvent));
  59
  60     if (officecfg::Office::Impress::MultiPaneGUI::NotesPane::Visible::ImpressView::get().value_or(
  61             false))
  62         AddActiveMainView(FrameworkHelper::msImpressViewURL);
  63     if (officecfg::Office::Impress::MultiPaneGUI::NotesPane::Visible::OutlineView::get().value_or(
  64             false))
  65         AddActiveMainView(FrameworkHelper::msOutlineViewURL);
  66     if (officecfg::Office::Impress::MultiPaneGUI::NotesPane::Visible::NotesView::get().value_or(
  67             false))
  68         AddActiveMainView(FrameworkHelper::msNotesViewURL);
  69 }
  70
  71 NotesPaneModule::~NotesPaneModule()
  72 {
  73     if (mpViewShellBase && mbListeningEventMultiplexer)
  74         mpViewShellBase->GetEventMultiplexer()->RemoveEventListener(
  75             LINK(this, NotesPaneModule, EventMultiplexerListener));
  76 }
  77
  78 void NotesPaneModule::AddActiveMainView(const OUString& rsMainViewURL)
  79 {
  80     maActiveMainViewContainer.insert(rsMainViewURL);
  81 }
  82
  83 bool NotesPaneModule::IsResourceActive(const OUString& rsMainViewURL)
  84 {
  85     return maActiveMainViewContainer.contains(rsMainViewURL);
  86 }
  87
  88 void NotesPaneModule::SaveResourceState()
  89 {
  90     auto xChanges = comphelper::ConfigurationChanges::create();
  91     officecfg::Office::Impress::MultiPaneGUI::NotesPane::Visible::ImpressView::set(
  92         IsResourceActive(FrameworkHelper::msImpressViewURL), xChanges);
  93     officecfg::Office::Impress::MultiPaneGUI::NotesPane::Visible::OutlineView::set(
  94         IsResourceActive(FrameworkHelper::msOutlineViewURL), xChanges);
  95     officecfg::Office::Impress::MultiPaneGUI::NotesPane::Visible::NotesView::set(
  96         IsResourceActive(FrameworkHelper::msNotesViewURL), xChanges);
  97     xChanges->commit();
  98 }
  99
 100 void NotesPaneModule::disposing(std::unique_lock<std::mutex>&)
 101 {
 102     if (mxConfigurationController.is())
 103     {
 104         mxConfigurationController->removeConfigurationChangeListener(this);
 105         mxConfigurationController = nullptr;
 106     }
 107 }
 108
 109 IMPL_LINK(NotesPaneModule, EventMultiplexerListener, sd::tools::EventMultiplexerEvent&, rEvent,
 110           void)
 111 {
 112     if (!mxConfigurationController.is())
 113         return;
 114
 115     switch (rEvent.meEventId)
 116     {
 117         case EventMultiplexerEventId::EditModeNormal:
 118             mbInMasterEditMode = false;
 119             if (IsResourceActive(msCurrentMainViewURL))
 120             {
 121                 mxConfigurationController->requestResourceActivation(
 122                     mxBottomImpressPaneId->getAnchor(), ResourceActivationMode_ADD);
 123                 mxConfigurationController->requestResourceActivation(
 124                     mxBottomImpressPaneId, ResourceActivationMode_REPLACE);
 125             }
 126             else
 127             {
 128                 mxConfigurationController->requestResourceDeactivation(mxBottomImpressPaneId);
 129             }
 130             break;
 131         case EventMultiplexerEventId::EditModeMaster:
 132             mbInMasterEditMode = true;
 133             mxConfigurationController->requestResourceDeactivation(mxBottomImpressPaneId);
 134             break;
 135         default:
 136             break;
 137     }
 138 }
 139
 140 void SAL_CALL NotesPaneModule::notifyConfigurationChange(const ConfigurationChangeEvent& rEvent)
 141 {
 142     if (!mxConfigurationController.is())
 143         return;
 144
 145     // the late init is hacked here since there's EventMultiplexer isn't available when the
 146     // NotesPaneModule is constructed
 147     if (!mbListeningEventMultiplexer)
 148     {
 149         mpViewShellBase->GetEventMultiplexer()->AddEventListener(
 150             LINK(this, NotesPaneModule, EventMultiplexerListener));
 151         mbListeningEventMultiplexer = true;
 152     }
 153
 154     sal_Int32 nEventType = 0;
 155     rEvent.UserData >>= nEventType;
 156     switch (nEventType)
 157     {
 158         case ResourceActivationRequestEvent:
 159             if (rEvent.ResourceId->isBoundToURL(FrameworkHelper::msCenterPaneURL,
 160                                                 AnchorBindingMode_DIRECT))
 161             {
 162                 if (rEvent.ResourceId->getResourceTypePrefix() == FrameworkHelper::msViewURLPrefix)
 163                 {
 164                     onMainViewSwitch(rEvent.ResourceId->getResourceURL(), true);
 165                 }
 166             }
 167             else if (rEvent.ResourceId->compareTo(mxBottomImpressPaneId) == 0)
 168             {
 169                 onResourceRequest(true, rEvent.Configuration);
 170             }
 171             break;
 172
 173         case ResourceDeactivationRequestEvent:
 174             if (rEvent.ResourceId->compareTo(mxMainViewAnchorId) == 0)
 175             {
 176                 onMainViewSwitch(OUString(), false);
 177             }
 178             else if (rEvent.ResourceId->compareTo(mxBottomImpressPaneId) == 0)
 179             {
 180                 onResourceRequest(false, rEvent.Configuration);
 181             }
 182             break;
 183         default:
 184             break;
 185     }
 186 }
 187
 188 void SAL_CALL NotesPaneModule::disposing(const lang::EventObject& rEvent)
 189 {
 190     if (mxConfigurationController.is() && rEvent.Source == mxConfigurationController)
 191     {
 192         SaveResourceState();
 193         // Without the configuration controller this class can do nothing.
 194         mxConfigurationController = nullptr;
 195         dispose();
 196     }
 197 }
 198
 199 void NotesPaneModule::onMainViewSwitch(const OUString& rsViewURL, const bool bIsActivated)
 200 {
 201     if (bIsActivated)
 202         msCurrentMainViewURL = rsViewURL;
 203     else
 204         msCurrentMainViewURL.clear();
 205
 206     if (!mxConfigurationController.is())
 207         return;
 208
 209     sd::framework::ConfigurationController::Lock aLock(mxConfigurationController);
 210
 211     if (IsResourceActive(msCurrentMainViewURL) && !mbInMasterEditMode)
 212     {
 213         mxConfigurationController->requestResourceActivation(mxBottomImpressPaneId->getAnchor(),
 214                                                              ResourceActivationMode_ADD);
 215         mxConfigurationController->requestResourceActivation(mxBottomImpressPaneId,
 216                                                              ResourceActivationMode_REPLACE);
 217     }
 218     else
 219     {
 220         mxConfigurationController->requestResourceDeactivation(mxBottomImpressPaneId);
 221     }
 222 }
 223
 224 bool NotesPaneModule::IsMasterView(const Reference<XView>& xView)
 225 {
 226     if (mpViewShellBase != nullptr)
 227     {
 228         auto pViewShellWrapper = dynamic_cast<ViewShellWrapper*>(xView.get());
 229         if (pViewShellWrapper)
 230         {
 231             std::shared_ptr<ViewShell> pViewShell = pViewShellWrapper->GetViewShell();
 232             auto pDrawViewShell = std::dynamic_pointer_cast<DrawViewShell>(pViewShell);
 233
 234             if (pDrawViewShell && pDrawViewShell->GetEditMode() == EditMode::MasterPage)
 235                 return true;
 236         }
 237     }
 238     return false;
 239 }
 240
 241 void NotesPaneModule::onResourceRequest(
 242     bool bActivation,
 243     const css::uno::Reference<css::drawing::framework::XConfiguration>& rxConfiguration)
 244 {
 245     Sequence<Reference<XResourceId>> aCenterViews = rxConfiguration->getResources(
 246         FrameworkHelper::CreateResourceId(FrameworkHelper::msCenterPaneURL),
 247         FrameworkHelper::msViewURLPrefix, AnchorBindingMode_DIRECT);
 248
 249     if (aCenterViews.getLength() != 1)
 250         return;
 251
 252     // do not record the state of bottom pane when in master edit modes
 253     if (!IsMasterView({ mxConfigurationController->getResource(aCenterViews[0]), UNO_QUERY }))
 254     {
 255         if (bActivation)
 256         {
 257             maActiveMainViewContainer.insert(aCenterViews[0]->getResourceURL());
 258         }
 259         else
 260         {
 261             maActiveMainViewContainer.erase(aCenterViews[0]->getResourceURL());
 262         }
 263     }
 264 }
 265
 266 } // end of namespace sd::framework
 267
 268 /* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */