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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/* -*- 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 <com/sun/star/drawing/framework/XConfiguration.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/container/XNamed.hpp>
#include <comphelper/compbase.hxx>
#include <memory>
namespace com::sun::star::util { class XCloneable; }
namespace com::sun::star::drawing::framework { class XConfigurationControllerBroadcaster; }
namespace sd::framework {
typedef comphelper::WeakComponentImplHelper <
css::drawing::framework::XConfiguration,
css::container::XNamed,
css::lang::XServiceInfo
> ConfigurationInterfaceBase;
/** A configuration describes the resources of an application like panes,
views, and tool bars and their relationships that are currently active
or are requested to be activated. Resources are specified by URLs rather
than references so that not only the current configuration but also a
requested configuration can be represented.
A resource URL describes the type of a resource, not its actual
instance. For resources, like panes, that are unique with respect to an
application frame, that does not mean much of a difference. For other
resources like views, that may have more than one instance per
application frame, this is different. To identify them unambiguously a
second URL, one of a unique resource, is necessary. This second URL is
called the anchor of the first. The two types of resources are called
unique and linked respectively.
Direct manipulation of a configuration object is not advised with the
exception of the configuration controller and objects that implement the
XConfigurationChangeOperation interface.
*/
class Configuration final
: public ConfigurationInterfaceBase
{
public:
/** Create a new configuration with a broadcaster that is used to send
events about requested configuration changes.
@param rxBroadcaster
This broadcaster is typically the same as the one used by the
ConfigurationController.
@param bBroadcastRequestEvents
When this is <TRUE/> then modifications to the configuration
trigger the broadcasting of "ResourceActivationRequestEvent" and
"ResourceDeactivationRequestEvent". When this flag is <FALSE/>
then events with type "ResourceActivationEvent" and
"ResourceDeactivationEvent" are broadcasted.
*/
Configuration (const css::uno::Reference<css::drawing::framework::XConfigurationControllerBroadcaster>& rxBroadcaster,
bool bBroadcastRequestEvents);
virtual ~Configuration() override;
virtual void disposing(std::unique_lock<std::mutex>&) override;
// XConfiguration
virtual void SAL_CALL addResource (
const css::uno::Reference<css::drawing::framework::XResourceId>&
rxResourceId) override;
virtual void SAL_CALL removeResource(
const css::uno::Reference<css::drawing::framework::XResourceId>&
rxResourceId) override;
virtual css::uno::Sequence< css::uno::Reference<
css::drawing::framework::XResourceId> > SAL_CALL getResources (
const css::uno::Reference<css::drawing::framework::XResourceId>& rxAnchorId,
const OUString& rsResourceURLPrefix,
css::drawing::framework::AnchorBindingMode eMode) override;
virtual sal_Bool SAL_CALL hasResource (
const css::uno::Reference<css::drawing::framework::XResourceId>&
rxResourceId) override;
// XCloneable
virtual css::uno::Reference<css::util::XCloneable>
SAL_CALL createClone() override;
// XNamed
/** Return a human readable string representation. This is used for
debugging purposes.
*/
virtual OUString SAL_CALL getName() override;
/** This call is ignored because the XNamed interface is (mis)used to
give access to a human readable name for debugging purposes.
*/
virtual void SAL_CALL setName (const OUString& rName) override;
OUString SAL_CALL getImplementationName() override;
sal_Bool SAL_CALL supportsService(OUString const & ServiceName) override;
css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override;
private:
class ResourceContainer;
/** The resource container holds the URLs of unique resource and of
resource linked to unique resources.
*/
std::unique_ptr<ResourceContainer> mpResourceContainer;
/** The broadcaster used for notifying listeners of requests for
configuration changes.
*/
css::uno::Reference<css::drawing::framework::XConfigurationControllerBroadcaster>
mxBroadcaster;
bool mbBroadcastRequestEvents;
/** This private variant of the constructor is used for cloning a
Configuration object.
@param rResourceContainer
The new Configuration is created with a copy of the elements in
this container.
*/
Configuration (const css::uno::Reference<css::drawing::framework::XConfigurationControllerBroadcaster>& rxBroadcaster,
bool bBroadcastRequestEvents,
const ResourceContainer& rResourceContainer);
/** Send an event to all interested listeners that a resource has been
added or removed. The event is sent to the listeners via the
ConfigurationController.
@param rxResourceId
The resource that is added to or removed from the configuration.
@param bActivation
This specifies whether an activation or deactivation is
broadcasted. The mbBroadcastRequestEvents member is also taken
into account when the actual event type field is determined.
*/
void PostEvent (
const css::uno::Reference<css::drawing::framework::XResourceId>& rxResourceId,
const bool bActivation);
/** When the called object has already been disposed this method throws
an exception and does not return.
@throws css::lang::DisposedException
*/
void ThrowIfDisposed() const;
};
/** Return whether the two given configurations contain the same resource
ids. The order of resource ids is ignored. Empty references are
treated like empty configurations.
*/
bool AreConfigurationsEquivalent (
const css::uno::Reference<css::drawing::framework::XConfiguration>& rxConfiguration1,
const css::uno::Reference<css::drawing::framework::XConfiguration>& rxConfiguration2);
} // end of namespace sd::framework
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
