sd/source/ui/framework/configuration/ChangeRequestQueueProcessor.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ChangeRequestQueueProcessor.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SD_FRAMEWORK_CHANGE_REQUEST_QUEUE_PROCESSOR_HXX
  32 #define SD_FRAMEWORK_CHANGE_REQUEST_QUEUE_PROCESSOR_HXX
  33
  34 #include "ChangeRequestQueue.hxx"
  35 #include <osl/mutex.hxx>
  36 #include <rtl/ref.hxx>
  37 #include <com/sun/star/drawing/framework/XConfigurationChangeRequest.hpp>
  38 #include <com/sun/star/drawing/framework/ConfigurationChangeEvent.hpp>
  39
  40 #include <cppuhelper/interfacecontainer.hxx>
  41 #include <tools/link.hxx>
  42
  43 #include <boost/shared_ptr.hpp>
  44
  45 namespace sd { namespace framework {
  46
  47 class ConfigurationController;
  48 class ConfigurationUpdater;
  49
  50 /** The ChangeRequestQueueProcessor ownes the ChangeRequestQueue and
  51     processes the configuration change requests.
  52
  53     When after processing one entry the queue is empty then the
  54     XConfigurationController::update() method is called so that the changes
  55     made to the local XConfiguration reference are reflected by the UI.
  56
  57     Queue entries are processed asynchronously by calling PostUserEvent().
  58 */
  59 class ChangeRequestQueueProcessor
  60 {
  61 public:
  62     /** The queue processor is created with a reference to an
  63         ConfigurationController so that its UpdateConfiguration() method can
  64         be called when the queue becomes empty.
  65     */
  66     ChangeRequestQueueProcessor (
  67         const ::rtl::Reference<ConfigurationController>& rxController,
  68         const ::boost::shared_ptr<ConfigurationUpdater>& rpUpdater);
  69     ~ChangeRequestQueueProcessor (void);
  70
  71     /** Sets the configuration who will be changed by subsequent change
  72         requests.  This method should be called only by the configuration
  73         controller who owns the configuration.
  74     */
  75     void SetConfiguration (
  76         const ::com::sun::star::uno::Reference<
  77             ::com::sun::star::drawing::framework::XConfiguration>& rxConfiguration);
  78
  79     /** The given request is appended to the end of the queue and will
  80         eventually be processed when all other entries in front of it have
  81         been processed.
  82     */
  83     void AddRequest (const ::com::sun::star::uno::Reference<
  84         ::com::sun::star::drawing::framework::XConfigurationChangeRequest>& rxRequest);
  85
  86     /** Returns </TRUE> when the queue is empty.
  87     */
  88     bool IsEmpty (void) const;
  89
  90     /** Process all events in the queue synchronously.
  91
  92         <p>This method is typically called when the framework is shut down
  93         to establish an empty configuration.</p>
  94     */
  95     void ProcessUntilEmpty (void);
  96
  97     /** Process the first event in queue.
  98     */
  99     void ProcessOneEvent (void);
 100
 101     /** Remove all events from the queue.
 102
 103         <p>This method is typically called when the framework is shut down
 104         to avoid the processing of still pending activation requests.</p>
 105     */
 106     void Clear (void);
 107
 108 private:
 109     mutable ::osl::Mutex maMutex;
 110
 111     ChangeRequestQueue maQueue;
 112
 113     /** The id returned by the last PostUserEvent() call.  This id is stored
 114         so that a pending user event can be removed whent he queue processor
 115         is destroyed.
 116     */
 117     sal_uIntPtr mnUserEventId;
 118
 119     ::com::sun::star::uno::Reference<
 120         ::com::sun::star::drawing::framework::XConfiguration> mxConfiguration;
 121
 122     ::rtl::Reference<ConfigurationController> mpConfigurationController;
 123
 124     ::boost::shared_ptr<ConfigurationUpdater> mpConfigurationUpdater;
 125
 126     /** Initiate the processing of the entries in the queue.  The actual
 127         processing starts asynchronously.
 128     */
 129     void StartProcessing (void);
 130
 131     /** Callback function for the PostUserEvent() call.
 132     */
 133     DECL_LINK(ProcessEvent,void*);
 134 };
 135
 136
 137 } } // end of namespace sd::framework
 138
 139 #endif