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
|
/* -*- 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 EXTENSIONS_OOOIMPROVEMENT_CONFIGURATIONHELPER_HXX
#define EXTENSIONS_OOOIMPROVEMENT_CONFIGURATIONHELPER_HXX
#include <com/sun/star/uno/XInterface.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/container/XHierarchicalNameAccess.hpp>
#include <com/sun/star/util/XChangesBatch.hpp>
#include <rtl/ustring.hxx>
namespace oooimprovement
{
#ifdef css
#error css defined globally
#endif
#define css ::com::sun::star
// Copy from comphelper module, we cant use that directly from an extension
class MyConfigurationHelper
{
public:
//-----------------------------------------------
/** specify all possible modes, which can be used to open a configuration access.
*
* @see openConfig()
* @see readDirectKey()
* @see writeDirectKey()
*/
enum EConfigurationModes
{
/// opens configuration in read/write mode (without LAZY writing!)
E_STANDARD = 0,
/// configuration will be opened readonly
E_READONLY = 1,
};
//-----------------------------------------------
/** returns access to the specified configuration package.
*
* This method should be used, if e.g. more then one request to the same
* configuration package is needed. The configuration access can be cached
* outside and used inbetween.
*
* @param xSMGR
* the uno service manager, which should be used to create the
* configuration access.
*
* @param sPackage
* the name of the configuration package.
* e.g. <ul>
* <li>org.openoffice.Office.Common</li>
* <li>org.openoffice.Office.Common/Menu</li>
* </ul>
*
* @param eMode
* specify the open mode for the returned configuration access.
* It's interpreted as a flag field and can be any usefull combination
* of values of EConfigurationModes.
*
* @throw css::uno::Any exceptions the underlying configuration can throw.
* E.g. css::uno::Exception if the configuration could not be opened.
*/
static css::uno::Reference< css::uno::XInterface> openConfig(
const css::uno::Reference< css::lang::XMultiServiceFactory> xSMGR,
const ::rtl::OUString& sPackage,
sal_Int32 eMode);
//-----------------------------------------------
/** reads the value of an existing(!) configuration key,
* which is searched relative to the specified configuration access.
*
* This method must be used in combination with openConfig().
* The cached configuration access must be provided here ... and
* all operations are made relativ to this access point.
*
* @param xCFG
* the configuration root, where sRelPath should be interpreted.
* as relativ path
*
* @param sRelPath
* path relative to xCFG parameter.
*
* @param sKey
* the configuration node, where we should read the value.
*
* @return [css.uno.css::uno::Any]
* the value of sKey.
*
* @throw css::uno::Any exceptions the underlying configuration can throw.
* E.g. css::container::NoSuchElementException if the specified
* key does not exists.
*/
static css::uno::Any readRelativeKey(
const css::uno::Reference< css::uno::XInterface> xCFG,
const ::rtl::OUString& sRelPath,
const ::rtl::OUString& sKey);
//-----------------------------------------------
/** writes a new value for an existing(!) configuration key,
* which is searched relative to the specified configuration access.
*
* This method must be used in combination with openConfig().
* The cached configuration access must be provided here ... and
* all operations are made relativ to this access point.
*
* @param xCFG
* the configuration root, where sRelPath should be interpreted.
* as relativ path
*
* @param sRelPath
* path relative to xCFG parameter.
*
* @param sKey
* the configuration node, where we should write the new value.
*
* @param aValue
* the new value for sKey.
*
* @throw css::uno::Any exceptions the underlying configuration can throw.
* E.g. css::container::NoSuchElementException if the specified
* key does not exists or css::uno::Exception if the provided configuration
* access does not allow writing for this key.
*/
static void writeRelativeKey(
const css::uno::Reference< css::uno::XInterface> xCFG,
const ::rtl::OUString& sRelPath,
const ::rtl::OUString& sKey,
const css::uno::Any& aValue);
//-----------------------------------------------
/** commit all changes made on the specified configuration access.
*
* This method must be used in combination with openConfig().
* The cached configuration access must be provided here.
*
* @param xCFG
* the configuration root, where changes should be commited.
*
* @throw css::uno::Any exceptions the underlying configuration can throw.
* E.g. uno::Exception if the provided configuration
* access does not allow writing for this set.
*/
static void flush(const css::uno::Reference< css::uno::XInterface>& xCFG);
//-----------------------------------------------
/** does the same then openConfig() & readRelativeKey() together.
*
* This method should be used for reading one key at one code place only.
* Because it opens the specified configuration package, reads the key and
* closes the configuration again.
*
* So its not very usefull to use this method for reading multiple keys at the same time.
* (Excepting these keys exists inside different configuration packages ...))
*/
static css::uno::Any readDirectKey(
const css::uno::Reference< css::lang::XMultiServiceFactory> xSMGR,
const ::rtl::OUString& sPackage,
const ::rtl::OUString& sRelPath,
const ::rtl::OUString& sKey,
sal_Int32 eMode);
//-----------------------------------------------
/** does the same then openConfig() / writeRelativeKey() & flush() together.
*
* This method should be used for writing one key at one code place only.
* Because it opens the specified configuration package, writes the key, flush
* all changes and closes the configuration again.
*
* So its not very usefull to use this method for writing multiple keys at the same time.
* (Excepting these keys exists inside different configuration packages ...))
*/
static void writeDirectKey(
const css::uno::Reference< css::lang::XMultiServiceFactory> xSMGR,
const ::rtl::OUString& sPackage,
const ::rtl::OUString& sRelPath,
const ::rtl::OUString& sKey,
const css::uno::Any& aValue,
sal_Int32 eMode);
};
#undef css
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
