sd/source/ui/framework/configuration/ChangeRequestQueueProcessor.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 "ChangeRequestQueue.hxx"
  23 #include <osl/mutex.hxx>
  24
  25 #include <tools/link.hxx>
  26
  27 #include <memory>
  28
  29 namespace com::sun::star::drawing::framework
  30 {
  31 class XConfiguration;
  32 }
  33 namespace com::sun::star::drawing::framework
  34 {
  35 class XConfigurationChangeRequest;
  36 }
  37
  38 struct ImplSVEvent;
  39
  40 namespace sd::framework
  41 {
  42 class ConfigurationUpdater;
  43
  44 /** The ChangeRequestQueueProcessor owns the ChangeRequestQueue and
  45     processes the configuration change requests.
  46
  47     When after processing one entry the queue is empty then the
  48     XConfigurationController::update() method is called so that the changes
  49     made to the local XConfiguration reference are reflected by the UI.
  50
  51     Queue entries are processed asynchronously by calling PostUserEvent().
  52 */
  53 class ChangeRequestQueueProcessor
  54 {
  55 public:
  56     /** The queue processor is created with a reference to an
  57         ConfigurationController so that its UpdateConfiguration() method can
  58         be called when the queue becomes empty.
  59     */
  60     explicit ChangeRequestQueueProcessor(std::shared_ptr<ConfigurationUpdater> pUpdater);
  61     ~ChangeRequestQueueProcessor();
  62
  63     /** Sets the configuration who will be changed by subsequent change
  64         requests.  This method should be called only by the configuration
  65         controller who owns the configuration.
  66     */
  67     void SetConfiguration(
  68         const css::uno::Reference<css::drawing::framework::XConfiguration>& rxConfiguration);
  69
  70     /** The given request is appended to the end of the queue and will
  71         eventually be processed when all other entries in front of it have
  72         been processed.
  73     */
  74     void AddRequest(
  75         const css::uno::Reference<css::drawing::framework::XConfigurationChangeRequest>& rxRequest);
  76
  77     /** Returns </sal_True> when the queue is empty.
  78     */
  79     bool IsEmpty() const;
  80
  81     /** Process all events in the queue synchronously.
  82
  83         <p>This method is typically called when the framework is shut down
  84         to establish an empty configuration.</p>
  85     */
  86     void ProcessUntilEmpty();
  87
  88     /** Process the first event in queue.
  89     */
  90     void ProcessOneEvent();
  91
  92     /** Remove all events from the queue.
  93
  94         <p>This method is typically called when the framework is shut down
  95         to avoid the processing of still pending activation requests.</p>
  96     */
  97     void Clear();
  98
  99 private:
 100     mutable ::osl::Mutex maMutex;
 101
 102     ChangeRequestQueue maQueue;
 103
 104     /** The id returned by the last PostUserEvent() call.  This id is stored
 105         so that a pending user event can be removed when the queue processor
 106         is destroyed.
 107     */
 108     ImplSVEvent* mnUserEventId;
 109
 110     css::uno::Reference<css::drawing::framework::XConfiguration> mxConfiguration;
 111
 112     std::shared_ptr<ConfigurationUpdater> mpConfigurationUpdater;
 113
 114     /** Initiate the processing of the entries in the queue.  The actual
 115         processing starts asynchronously.
 116     */
 117     void StartProcessing();
 118
 119     /** Callback function for the PostUserEvent() call.
 120     */
 121     DECL_LINK(ProcessEvent, void*, void);
 122 };
 123
 124 } // end of namespace sd::framework
 125
 126 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */