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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
|
/* -*- 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 .
*/
#ifndef INCLUDED_FRAMEWORK_SOURCE_INC_ACCELERATORS_ACCELERATORCONFIGURATION_HXX
#define INCLUDED_FRAMEWORK_SOURCE_INC_ACCELERATORS_ACCELERATORCONFIGURATION_HXX
#include <accelerators/istoragelistener.hxx>
#include <accelerators/presethandler.hxx>
#include <accelerators/acceleratorcache.hxx>
#include <accelerators/keymapping.hxx>
#include <macros/xinterface.hxx>
#include <macros/xtypeprovider.hxx>
#include <threadhelp/threadhelpbase.hxx>
#include <general.h>
#include <stdtypes.h>
#include <com/sun/star/container/XNameAccess.hpp>
#include <com/sun/star/lang/XTypeProvider.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/ui/XAcceleratorConfiguration.hpp>
#include <com/sun/star/ui/XUIConfiguration.hpp>
#include <com/sun/star/ui/XUIConfigurationPersistence.hpp>
#include <com/sun/star/ui/XUIConfigurationStorage.hpp>
#include <com/sun/star/io/XStream.hpp>
#include <com/sun/star/io/XInputStream.hpp>
#include <com/sun/star/io/XOutputStream.hpp>
#include <com/sun/star/util/XChangesListener.hpp>
// TODO use XPresetHandler interface instead if available
#include <com/sun/star/form/XReset.hpp>
#include <cppuhelper/propshlp.hxx>
#include <cppuhelper/implbase2.hxx>
#include <cppuhelper/implbase4.hxx>
#include <salhelper/singletonref.hxx>
//__________________________________________
// definition
namespace framework
{
const char CFG_ENTRY_PRIMARY[] = "PrimaryKeys";
const char CFG_ENTRY_GLOBAL[] = "Global";
const char CFG_ENTRY_MODULES[] = "Modules";
/** "global" type to make accelerator presets unique, so they can be used
in combination with the salhelper::SingletonRef mechanism! */
typedef PresetHandler AcceleratorPresets;
//__________________________________________
/**
implements a read/write access to the accelerator configuration.
*/
class XMLBasedAcceleratorConfiguration : protected ThreadHelpBase, // attention! Must be the first base class to guarentee right initialize lock ...
public IStorageListener,
public ::cppu::WeakImplHelper2<
css::form::XReset, // TODO use XPresetHandler instead if available
css::ui::XAcceleratorConfiguration > // => css::ui::XUIConfigurationPersistence
// css::ui::XUIConfigurationStorage
// css::ui::XUIConfiguration
{
//______________________________________
// member
protected:
//---------------------------------------
/** the global uno service manager.
Must be used to create own needed services. */
css::uno::Reference< css::uno::XComponentContext > m_xContext;
//---------------------------------------
/** used to:
i ) copy configuration files from the share to the user layer
ii ) provide access to these config files
iii) cache all sub storages on the path from the top to the bottom(!)
iv ) provide commit for changes. */
PresetHandler m_aPresetHandler;
//---------------------------------------
/** contains the cached configuration data */
AcceleratorCache m_aReadCache;
//---------------------------------------
/** used to implement the copy on write pattern! */
AcceleratorCache* m_pWriteCache;
//______________________________________
// native interface!
public:
XMLBasedAcceleratorConfiguration( const css::uno::Reference< css::uno::XComponentContext >& xContext);
virtual ~XMLBasedAcceleratorConfiguration( );
//______________________________________
// uno interface!
public:
// XAcceleratorConfiguration
virtual css::uno::Sequence< css::awt::KeyEvent > SAL_CALL getAllKeyEvents()
throw(css::uno::RuntimeException);
virtual OUString SAL_CALL getCommandByKeyEvent(const css::awt::KeyEvent& aKeyEvent)
throw(css::container::NoSuchElementException,
css::uno::RuntimeException );
virtual void SAL_CALL setKeyEvent(const css::awt::KeyEvent& aKeyEvent,
const OUString& sCommand )
throw(css::lang::IllegalArgumentException,
css::uno::RuntimeException );
virtual void SAL_CALL removeKeyEvent(const css::awt::KeyEvent& aKeyEvent)
throw(css::container::NoSuchElementException,
css::uno::RuntimeException );
virtual css::uno::Sequence< css::awt::KeyEvent > SAL_CALL getKeyEventsByCommand(const OUString& sCommand)
throw(css::lang::IllegalArgumentException ,
css::container::NoSuchElementException,
css::uno::RuntimeException );
virtual css::uno::Sequence< css::uno::Any > SAL_CALL getPreferredKeyEventsForCommandList(const css::uno::Sequence< OUString >& lCommandList)
throw(css::lang::IllegalArgumentException ,
css::uno::RuntimeException );
virtual void SAL_CALL removeCommandFromAllKeyEvents(const OUString& sCommand)
throw(css::lang::IllegalArgumentException ,
css::container::NoSuchElementException,
css::uno::RuntimeException );
// XUIConfigurationPersistence
virtual void SAL_CALL reload()
throw(css::uno::Exception ,
css::uno::RuntimeException);
virtual void SAL_CALL store()
throw(css::uno::Exception ,
css::uno::RuntimeException);
virtual void SAL_CALL storeToStorage(const css::uno::Reference< css::embed::XStorage >& xStorage)
throw(css::uno::Exception ,
css::uno::RuntimeException);
virtual ::sal_Bool SAL_CALL isModified()
throw(css::uno::RuntimeException);
virtual ::sal_Bool SAL_CALL isReadOnly()
throw(css::uno::RuntimeException);
// XUIConfigurationStorage
virtual void SAL_CALL setStorage(const css::uno::Reference< css::embed::XStorage >& xStorage)
throw(css::uno::RuntimeException);
virtual ::sal_Bool SAL_CALL hasStorage()
throw(css::uno::RuntimeException);
// XUIConfiguration
virtual void SAL_CALL addConfigurationListener(const css::uno::Reference< css::ui::XUIConfigurationListener >& xListener)
throw(css::uno::RuntimeException);
virtual void SAL_CALL removeConfigurationListener(const css::uno::Reference< css::ui::XUIConfigurationListener >& xListener)
throw(css::uno::RuntimeException);
// XReset
// TODO use XPresetHandler instead if available
virtual void SAL_CALL reset()
throw(css::uno::RuntimeException);
virtual void SAL_CALL addResetListener(const css::uno::Reference< css::form::XResetListener >& xListener)
throw(css::uno::RuntimeException);
virtual void SAL_CALL removeResetListener(const css::uno::Reference< css::form::XResetListener >& xListener)
throw(css::uno::RuntimeException);
// IStorageListener
virtual void changesOccurred(const OUString& sPath);
//______________________________________
// helper for derived classes
protected:
//---------------------------------------
/** @short return the current office locale.
@descr We does not cache this value, because we are not listen
for changes on the configuration layer ...
@return OUString
The current office locale as BCP47 string.
*/
OUString impl_ts_getLocale() const;
//______________________________________
// helper
private:
//---------------------------------------
/** @short load a configuration set, using the given stream.
@param xStream
provides the XML structure as stream.
*/
void impl_ts_load(const css::uno::Reference< css::io::XInputStream >& xStream);
//---------------------------------------
/** @short save a configuration set, using the given stream.
@param xStream
the XML structure can be written there.
*/
void impl_ts_save(const css::uno::Reference< css::io::XOutputStream >& xStream);
//---------------------------------------
/** @short try to locate and open a sub storage.
@descr It search at the root storage for the specified
sub storage. If it exists - it will be opened.
By default this method tries to open the storage
for reading. But the calli can request a writeable
storage.
@param xRooStorage
used to locate the sub storage.
@param sSubStorage
relativ path of the sub storage.
@param bOutStream
force open of the sub storage in
write mode - instead of read mode, which
is the default.
@return [XInterface]
will be a css::io::XInpoutStream or a css::io::XOutputStream.
Depends from the parameter bWriteable!
*/
css::uno::Reference< css::uno::XInterface > impl_ts_openSubStorage(const css::uno::Reference< css::embed::XStorage >& xRootStorage,
const OUString& sSubStorage ,
sal_Bool bOutStream );
//---------------------------------------
/** @short returns a reference to one of our internal cache members.
@descr We implement the copy-on-write pattern. Doing so
we know two caches internaly. The second one is used
only, if the container was changed.
This method here returns access to one of these
caches - depending on the change state of this
configuration service.
@param bWriteAccessRequested
if the outside code wish to change the container
it must call this method with "sal_True". So the internal
cache can be prepared for that (means copy-on-write ...).
@return [AcceleratorCache]
c++ reference(!) to one of our internal caches.
*/
AcceleratorCache& impl_getCFG(sal_Bool bWriteAccessRequested = sal_False);
};
class XCUBasedAcceleratorConfiguration : protected ThreadHelpBase, // attention! Must be the first base class to guarentee right initialize lock ...
public ::cppu::WeakImplHelper4<
css::util::XChangesListener,
css::lang::XComponent,
css::form::XReset, // TODO use XPresetHandler instead if available
css::ui::XAcceleratorConfiguration > // => css::ui::XUIConfigurationPersistence
// css::ui::XUIConfigurationStorage
// css::ui::XUIConfiguration
{
//______________________________________
// member
protected:
//---------------------------------------
/** the global uno service manager.
Must be used to create own needed services. */
css::uno::Reference< css::uno::XComponentContext > m_xContext;
css::uno::Reference< css::container::XNameAccess > m_xCfg;
AcceleratorCache m_aPrimaryReadCache;
AcceleratorCache m_aSecondaryReadCache;
AcceleratorCache* m_pPrimaryWriteCache;
AcceleratorCache* m_pSecondaryWriteCache;
OUString m_sGlobalOrModules;
OUString m_sModuleCFG;
::salhelper::SingletonRef< KeyMapping > m_rKeyMapping;
//______________________________________
// native interface!
public:
XCUBasedAcceleratorConfiguration( const css::uno::Reference< css::uno::XComponentContext >& xContext );
virtual ~XCUBasedAcceleratorConfiguration( );
//______________________________________
// uno interface!
public:
// XAcceleratorConfiguration
virtual css::uno::Sequence< css::awt::KeyEvent > SAL_CALL getAllKeyEvents()
throw(css::uno::RuntimeException);
virtual OUString SAL_CALL getCommandByKeyEvent(const css::awt::KeyEvent& aKeyEvent)
throw(css::container::NoSuchElementException,
css::uno::RuntimeException );
virtual void SAL_CALL setKeyEvent(const css::awt::KeyEvent& aKeyEvent,
const OUString& sCommand )
throw(css::lang::IllegalArgumentException,
css::uno::RuntimeException );
virtual void SAL_CALL removeKeyEvent(const css::awt::KeyEvent& aKeyEvent)
throw(css::container::NoSuchElementException,
css::uno::RuntimeException );
virtual css::uno::Sequence< css::awt::KeyEvent > SAL_CALL getKeyEventsByCommand(const OUString& sCommand)
throw(css::lang::IllegalArgumentException ,
css::container::NoSuchElementException,
css::uno::RuntimeException );
virtual css::uno::Sequence< css::uno::Any > SAL_CALL getPreferredKeyEventsForCommandList(const css::uno::Sequence< OUString >& lCommandList)
throw(css::lang::IllegalArgumentException ,
css::uno::RuntimeException );
virtual void SAL_CALL removeCommandFromAllKeyEvents(const OUString& sCommand)
throw(css::lang::IllegalArgumentException ,
css::container::NoSuchElementException,
css::uno::RuntimeException );
// XUIConfigurationPersistence
virtual void SAL_CALL reload()
throw(css::uno::Exception ,
css::uno::RuntimeException);
virtual void SAL_CALL store()
throw(css::uno::Exception ,
css::uno::RuntimeException);
virtual void SAL_CALL storeToStorage(const css::uno::Reference< css::embed::XStorage >& xStorage)
throw(css::uno::Exception ,
css::uno::RuntimeException);
virtual ::sal_Bool SAL_CALL isModified()
throw(css::uno::RuntimeException);
virtual ::sal_Bool SAL_CALL isReadOnly()
throw(css::uno::RuntimeException);
// XUIConfigurationStorage
virtual void SAL_CALL setStorage(const css::uno::Reference< css::embed::XStorage >& xStorage)
throw(css::uno::RuntimeException);
virtual ::sal_Bool SAL_CALL hasStorage()
throw(css::uno::RuntimeException);
// XUIConfiguration
virtual void SAL_CALL addConfigurationListener(const css::uno::Reference< css::ui::XUIConfigurationListener >& xListener)
throw(css::uno::RuntimeException);
virtual void SAL_CALL removeConfigurationListener(const css::uno::Reference< css::ui::XUIConfigurationListener >& xListener)
throw(css::uno::RuntimeException);
// XReset
// TODO use XPresetHandler instead if available
virtual void SAL_CALL reset()
throw(css::uno::RuntimeException);
virtual void SAL_CALL addResetListener(const css::uno::Reference< css::form::XResetListener >& xListener)
throw(css::uno::RuntimeException);
virtual void SAL_CALL removeResetListener(const css::uno::Reference< css::form::XResetListener >& xListener)
throw(css::uno::RuntimeException);
// css.util.XChangesListener
virtual void SAL_CALL changesOccurred(const css::util::ChangesEvent& aEvent)
throw(css::uno::RuntimeException);
// css.lang.XEventListener
virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent)
throw(css::uno::RuntimeException);
// XComponent
virtual void SAL_CALL dispose() throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL addEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& xListener ) throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL removeEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& aListener ) throw (::com::sun::star::uno::RuntimeException);
//______________________________________
// helper for derived classes
protected:
//---------------------------------------
/** @short return the current office locale.
@descr We does not cache this value, because we are not listen
for changes on the configuration layer ...
@return OUString
The current office locale as BCP47 string.
*/
OUString impl_ts_getLocale() const;
//______________________________________
// helper
private:
void impl_ts_load(sal_Bool bPreferred, const css::uno::Reference< css::container::XNameAccess >& xCfg);
void impl_ts_save(sal_Bool bPreferred, const css::uno::Reference< css::container::XNameAccess >& xCfg);
void insertKeyToConfiguration(const css::awt::KeyEvent& aKeyEvent, const OUString& sCommand, const sal_Bool bPreferred);
void removeKeyFromConfiguration(const css::awt::KeyEvent& aKeyEvent, const sal_Bool bPreferred);
void reloadChanged(const OUString& sPrimarySecondary, const OUString& sGlobalModules, const OUString& sModule, const OUString& sKey);
AcceleratorCache& impl_getCFG(sal_Bool bPreferred, sal_Bool bWriteAccessRequested = sal_False);
};
} // namespace framework
#endif // INCLUDED_FRAMEWORK_SOURCE_INC_ACCELERATORS_ACCELERATORCONFIGURATION_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
