sd/source/ui/framework/factories/ChildWindowPane.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 <memory>
  21 #include <sal/config.h>
  22 #include <sal/log.hxx>
  23
  24 #include <utility>
  25
  26 #include "ChildWindowPane.hxx"
  27
  28 #include <titledockwin.hxx>
  29 #include <ViewShellBase.hxx>
  30 #include <ViewShellManager.hxx>
  31 #include <toolkit/helper/vclunohelper.hxx>
  32 #include <sfx2/viewfrm.hxx>
  33
  34 using namespace ::com::sun::star;
  35 using namespace ::com::sun::star::uno;
  36 using namespace ::com::sun::star::drawing::framework;
  37
  38 namespace sd::framework {
  39
  40 ChildWindowPane::ChildWindowPane (
  41     const Reference<XResourceId>& rxPaneId,
  42     sal_uInt16 nChildWindowId,
  43     ViewShellBase& rViewShellBase,
  44     ::std::unique_ptr<SfxShell> && pShell)
  45     : ChildWindowPaneInterfaceBase(rxPaneId,nullptr),
  46       mnChildWindowId(nChildWindowId),
  47       mrViewShellBase(rViewShellBase),
  48       mpShell(std::move(pShell)),
  49       mbHasBeenActivated(false)
  50 {
  51     // ChildWindowPane shells don't implement dispatch slots, so activate them
  52     // at the bottom of the shellstack.
  53     mrViewShellBase.GetViewShellManager()->ActivateLowPriorityShell(mpShell.get());
  54
  55     SfxViewFrame& rViewFrame = mrViewShellBase.GetViewFrame();
  56
  57     if (mrViewShellBase.IsActive())
  58     {
  59         if (rViewFrame.KnowsChildWindow(mnChildWindowId))
  60         {
  61             if (rViewFrame.HasChildWindow(mnChildWindowId))
  62             {
  63                 // The ViewShellBase has already been activated.  Make
  64                 // the child window visible as soon as possible.
  65                 rViewFrame.SetChildWindow(mnChildWindowId, true);
  66             }
  67             else
  68             {
  69                 // The window is created asynchronously.  Rely on the
  70                 // ConfigurationUpdater to try another update, and with
  71                 // that another request for this window, in a short
  72                 // time.
  73             }
  74         }
  75         else
  76         {
  77             SAL_WARN("sd", "ChildWindowPane:not known");
  78         }
  79     }
  80     else
  81     {
  82         // The ViewShellBase has not yet been activated.  Hide the
  83         // window and wait a little before it is made visible.  See
  84         // comments in the GetWindow() method for an explanation.
  85         rViewFrame.SetChildWindow(mnChildWindowId, false);
  86     }
  87 }
  88
  89 ChildWindowPane::~ChildWindowPane()
  90 {
  91 }
  92
  93 void ChildWindowPane::Hide()
  94 {
  95     SfxViewFrame& rViewFrame = mrViewShellBase.GetViewFrame();
  96     if (rViewFrame.KnowsChildWindow(mnChildWindowId))
  97         if (rViewFrame.HasChildWindow(mnChildWindowId))
  98             rViewFrame.SetChildWindow(mnChildWindowId, false);
  99
 100     // Release the window because when the child window is shown again it
 101     // may use a different window.
 102     mxWindow = nullptr;
 103 }
 104
 105 void SAL_CALL ChildWindowPane::disposing()
 106 {
 107     ::osl::MutexGuard aGuard (m_aMutex);
 108
 109     mrViewShellBase.GetViewShellManager()->DeactivateShell(mpShell.get());
 110     mpShell.reset();
 111
 112     if (mxWindow.is())
 113     {
 114         mxWindow->removeEventListener(this);
 115     }
 116
 117     Pane::disposing();
 118 }
 119
 120 vcl::Window* ChildWindowPane::GetWindow()
 121 {
 122     do
 123     {
 124         if (mxWindow.is())
 125             // Window already exists => nothing to do.
 126             break;
 127
 128         // When the window is not yet present then obtain it only when the
 129         // shell has already been activated.  The activation is not
 130         // necessary for the code to work properly but is used to optimize
 131         // the layouting and displaying of the window.  When it is made
 132         // visible too early then some layouting seems to be made twice or at
 133         // an inconvenient time and the overall process of initializing the
 134         // Impress takes longer.
 135         if (!mbHasBeenActivated && mpShell != nullptr && !mpShell->IsActive())
 136             break;
 137
 138         mbHasBeenActivated = true;
 139         SfxViewFrame& rViewFrame = mrViewShellBase.GetViewFrame();
 140         // The view frame has to know the child window.  This can be the
 141         // case, when for example the document is in read-only mode:  the
 142         // task pane is then not available.
 143         if ( ! rViewFrame.KnowsChildWindow(mnChildWindowId))
 144             break;
 145
 146         rViewFrame.SetChildWindow(mnChildWindowId, true);
 147         SfxChildWindow* pChildWindow = rViewFrame.GetChildWindow(mnChildWindowId);
 148         if (pChildWindow == nullptr)
 149             if (rViewFrame.HasChildWindow(mnChildWindowId))
 150             {
 151                 // The child window is not yet visible.  Ask the view frame
 152                 // to show it and try again to get access to the child
 153                 // window.
 154                 rViewFrame.ShowChildWindow(mnChildWindowId);
 155                 pChildWindow = rViewFrame.GetChildWindow(mnChildWindowId);
 156             }
 157
 158         // When the child window is still not visible then we have to try later.
 159         if (pChildWindow == nullptr)
 160             break;
 161
 162         // From the child window get the docking window and from that the
 163         // content window that is the container for the actual content.
 164         TitledDockingWindow* pDockingWindow = dynamic_cast<TitledDockingWindow*>(
 165             pChildWindow->GetWindow());
 166         if (pDockingWindow == nullptr)
 167             break;
 168
 169         // At last, we have access to the window and its UNO wrapper.
 170         mpWindow = &pDockingWindow->GetContentWindow();
 171         mxWindow = VCLUnoHelper::GetInterface(mpWindow);
 172
 173         // Register as window listener to be informed when the child window
 174         // is hidden.
 175         if (mxWindow.is())
 176             mxWindow->addEventListener(this);
 177     }
 178     while (false);
 179
 180     return mpWindow;
 181 }
 182
 183 Reference<awt::XWindow> SAL_CALL ChildWindowPane::getWindow()
 184 {
 185     if (mpWindow == nullptr || ! mxWindow.is())
 186         GetWindow();
 187     return Pane::getWindow();
 188 }
 189
 190 IMPLEMENT_FORWARD_XINTERFACE2(
 191     ChildWindowPane,
 192     ChildWindowPaneInterfaceBase,
 193     Pane);
 194 IMPLEMENT_FORWARD_XTYPEPROVIDER2(
 195     ChildWindowPane,
 196     ChildWindowPaneInterfaceBase,
 197     Pane);
 198
 199 //----- XEventListener --------------------------------------------------------
 200
 201 void SAL_CALL ChildWindowPane::disposing (const lang::EventObject& rEvent)
 202 {
 203     ThrowIfDisposed();
 204
 205     if (rEvent.Source == mxWindow)
 206     {
 207         // The window is gone but the pane remains alive.  The next call to
 208         // GetWindow() may create the window anew.
 209         mxWindow = nullptr;
 210         mpWindow = nullptr;
 211     }
 212 }
 213
 214 } // end of namespace sd::framework
 215
 216 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */