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