sd/source/ui/framework/module/ShellStackGuard.hxx

   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 #pragma once
  21
  22 #include <framework/ConfigurationController.hxx>
  23
  24 #include <com/sun/star/drawing/framework/XConfigurationChangeListener.hpp>
  25
  26 #include <rtl/ref.hxx>
  27 #include <vcl/idle.hxx>
  28 #include <comphelper/compbase.hxx>
  29 #include <memory>
  30
  31 namespace com::sun::star::drawing::framework
  32 {
  33 class XConfigurationController;
  34 }
  35 namespace com::sun::star::frame
  36 {
  37 class XController;
  38 }
  39
  40 namespace sd
  41 {
  42 class DrawController;
  43 class ViewShellBase;
  44 }
  45
  46 namespace sd::framework
  47 {
  48 typedef comphelper::WeakComponentImplHelper<css::drawing::framework::XConfigurationChangeListener>
  49     ShellStackGuardInterfaceBase;
  50
  51 /** This module locks updates of the current configuration in situations
  52     when the shell stack must not be modified.
  53
  54     On every start of a configuration update the ShellStackGuard checks the
  55     printer.  If it is printing the configuration update is locked.  It then
  56     polls the printer and unlocks updates when printing finishes.
  57
  58     When in the future there are no resources left that use shells then this
  59     module can be removed.
  60 */
  61 class ShellStackGuard : public ShellStackGuardInterfaceBase
  62 {
  63 public:
  64     explicit ShellStackGuard(rtl::Reference<sd::DrawController> const& rxController);
  65     virtual ~ShellStackGuard() override;
  66
  67     virtual void disposing(std::unique_lock<std::mutex>&) override;
  68
  69     // XConfigurationChangeListener
  70
  71     virtual void SAL_CALL notifyConfigurationChange(
  72         const css::drawing::framework::ConfigurationChangeEvent& rEvent) override;
  73
  74     // XEventListener
  75
  76     virtual void SAL_CALL disposing(const css::lang::EventObject& rEvent) override;
  77
  78 private:
  79     css::uno::Reference<css::drawing::framework::XConfigurationController>
  80         mxConfigurationController;
  81     ViewShellBase* mpBase;
  82     std::unique_ptr<ConfigurationController::Lock> mpUpdateLock;
  83     Idle maPrinterPollingIdle;
  84
  85     DECL_LINK(TimeoutHandler, Timer*, void);
  86
  87     /** Return <TRUE/> when the printer is printing.  Return <FALSE/> when
  88         the printer is not printing, or there is no printer, or something
  89         else went wrong.
  90     */
  91     bool IsPrinting() const;
  92 };
  93
  94 } // end of namespace sd::framework
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */