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