blob: 4afd5af767a26def03f96d880ed1e69d344ea2f3 (
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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#pragma once
#include "ChangeRequestQueue.hxx"
#include <osl/mutex.hxx>
#include <tools/link.hxx>
#include <memory>
namespace com::sun::star::drawing::framework
{
class XConfiguration;
}
namespace com::sun::star::drawing::framework
{
class XConfigurationChangeRequest;
}
struct ImplSVEvent;
namespace sd::framework
{
class ConfigurationUpdater;
/** The ChangeRequestQueueProcessor owns 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.
*/
explicit ChangeRequestQueueProcessor(const std::shared_ptr<ConfigurationUpdater>& rpUpdater);
~ChangeRequestQueueProcessor();
/** 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 css::uno::Reference<css::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 css::uno::Reference<css::drawing::framework::XConfigurationChangeRequest>& rxRequest);
/** Returns </sal_True> when the queue is empty.
*/
bool IsEmpty() 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();
/** Process the first event in queue.
*/
void ProcessOneEvent();
/** 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();
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 when the queue processor
is destroyed.
*/
ImplSVEvent* mnUserEventId;
css::uno::Reference<css::drawing::framework::XConfiguration> mxConfiguration;
std::shared_ptr<ConfigurationUpdater> mpConfigurationUpdater;
/** Initiate the processing of the entries in the queue. The actual
processing starts asynchronously.
*/
void StartProcessing();
/** Callback function for the PostUserEvent() call.
*/
DECL_LINK(ProcessEvent, void*, void);
};
} // end of namespace sd::framework
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
