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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* 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_CONFIGURATION_CONFIGURATION_HXX
#define SD_FRAMEWORK_CONFIGURATION_CONFIGURATION_HXX
#include "MutexOwner.hxx"
#include <com/sun/star/drawing/framework/XConfiguration.hpp>
#include <com/sun/star/drawing/framework/XConfigurationControllerBroadcaster.hpp>
#include <com/sun/star/util/XCloneable.hpp>
#include <com/sun/star/container/XNamed.hpp>
#include <cppuhelper/compbase2.hxx>
#include <boost/scoped_ptr.hpp>
namespace {
typedef ::cppu::WeakComponentImplHelper2 <
::com::sun::star::drawing::framework::XConfiguration,
::com::sun::star::container::XNamed
> ConfigurationInterfaceBase;
} // end of anonymous namespace.
namespace sd { namespace framework {
/** 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 unambigously 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
: private sd::MutexOwner,
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 ::com::sun::star::uno::Reference<
::com::sun::star::drawing::framework::XConfigurationControllerBroadcaster>& rxBroadcaster,
bool bBroadcastRequestEvents);
virtual ~Configuration (void);
virtual void SAL_CALL disposing (void);
// XConfiguration
virtual void SAL_CALL addResource (
const ::com::sun::star::uno::Reference<com::sun::star::drawing::framework::XResourceId>&
rxResourceId)
throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL removeResource(
const ::com::sun::star::uno::Reference<com::sun::star::drawing::framework::XResourceId>&
rxResourceId)
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Sequence< com::sun::star::uno::Reference<
com::sun::star::drawing::framework::XResourceId> > SAL_CALL getResources (
const ::com::sun::star::uno::Reference<
::com::sun::star::drawing::framework::XResourceId>& rxAnchorId,
const ::rtl::OUString& rsResourceURLPrefix,
::com::sun::star::drawing::framework::AnchorBindingMode eMode)
throw (::com::sun::star::uno::RuntimeException);
virtual sal_Bool SAL_CALL hasResource (
const ::com::sun::star::uno::Reference<com::sun::star::drawing::framework::XResourceId>&
rxResourceId)
throw (::com::sun::star::uno::RuntimeException);
// XCloneable
virtual ::com::sun::star::uno::Reference<com::sun::star::util::XCloneable>
SAL_CALL createClone (void)
throw (::com::sun::star::uno::RuntimeException);
// XNamed
/** Return a human readable string representation. This is used for
debugging purposes.
*/
virtual ::rtl::OUString SAL_CALL getName (void)
throw (::com::sun::star::uno::RuntimeException);
/** 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 ::rtl::OUString& rName)
throw (::com::sun::star::uno::RuntimeException);
private:
class ResourceContainer;
/** The resource container holds the URLs of unique resource and of
resource linked to unique resources.
*/
::boost::scoped_ptr<ResourceContainer> mpResourceContainer;
/** The broadcaster used for notifying listeners of requests for
configuration changes.
*/
::com::sun::star::uno::Reference<
::com::sun::star::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 ::com::sun::star::uno::Reference<
::com::sun::star::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 ::com::sun::star::uno::Reference<com::sun::star::drawing::framework::XResourceId>&
rxResourceId,
const bool bActivation);
/** When the called object has already been disposed this method throws
an exception and does not return.
*/
void ThrowIfDisposed (void) const
throw (::com::sun::star::lang::DisposedException);
};
/** 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 ::com::sun::star::uno::Reference<
::com::sun::star::drawing::framework::XConfiguration>& rxConfiguration1,
const ::com::sun::star::uno::Reference<
::com::sun::star::drawing::framework::XConfiguration>& rxConfiguration2);
} } // end of namespace sd::framework
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
