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
|
/*************************************************************************
*
* $RCSfile: NestedRegistry.idl,v $
*
* $Revision: 1.8 $
*
* last change: $Author: mi $ $Date: 2002-12-10 10:31:36 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_registry_DefaultRegistry_idl__
#define __com_sun_star_registry_DefaultRegistry_idl__
#ifndef __com_sun_star_registry_XSimpleRegistry_idl__
#include <com/sun/star/registry/XSimpleRegistry.idl>
#endif
#ifndef __com_sun_star_lang_XInitialization_idl__
#include <com/sun/star/lang/XInitialization.idl>
#endif
//=============================================================================
module com { module sun { module star { module registry {
//=============================================================================
// DocMerge from xml: service com::sun::star::registry::NestedRegistry
/** supports a shared view on two different registries. The registry
files will be opened in two different modes, registry1 will be opened with read/write
rights and registry2 will be opened read-only.
In the context of this service, the functions <code>open</code>, <code>close</code>,
and <code>destroy</code> from <type>XSimpleRegistry</type> are not supported and
throw an exception if they are used.
<dl>
<dt>Functions of <type>XSimpleRegistry</type>:
<dl>
<dt> <b>getURL</b>
</dt>
<dd> returns the name of registry1.
</dd>
<dt> <b>isValid</b>
</dt>
<dd> checks if registry1 is valid. If the interface is not <NULL/>
then registry1 should always be valid.
</dd>
<dt> <b>isReadOnly</b>
</dt>
<dd> checks if registry1 has write protection.
</dd>
<dt> <b>mergeKey</b>
</dt>
<dd> merges all information from the specified registry in registry1.
</dd>
<dt> <b>getRootKey</b>
</dt>
<dd> returns a virtual rootkey of both registries.
</dd>
</dl>
<br>
</dt>
<dt>Functions of <type>XRegistryKey</type>:
<dl>
<dt> <b>openKey</b>
</dt>
<dd> returns a virtual key which is specified in registy1 or registry2.
</dd>
<dt> <b>deleteKey</b>
</dt>
<dd> deletes the key only if it is present in registry1.
</dd>
<dt> <b>setLongValue, setAsciiValue, setStringValue, setBinaryValue</b>
</dt>
<dd> sets the value at the specified key in registry1.
</dd>
<dt> <b>getLongValue, getAsciiValue, getStringValue, getBinaryValue</b>
</dt>
<dd> returns the value at the specified key in registry1, or if
the value is not present in registry1, it will return the value of registry2.
</dd>
<dt> <b>openKeys</b>
</dt>
<dd> returns a sequence of all subkeys in both registries.
</dd>
<dt> <b>getKeyNames</b>
</dt>
<dd> returns a sequence with the names of all subkeys in both
registries.
</dd>
<dt>
<br>
<b>Note: all write functions only work on registry1.</b>
</dt>
</dl>
</dt>
</dl>
<br>
How to initialize the registries:<br>
Use a sequence of <type>XSimpleRegistry</type> with two elements. The first element must be
the registry which is opened with read/write rights and the second element must be
the read-only one.<br>
Two different ways are possible:<br>
<ul>
<li> use <method scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</method> to
create an instance of this service where the value of the any parameter must be the sequence with
the two open registries.
<li> use the initialize function of the <type scope="com::sun::star::lang">XInitialization</type> interface where the value of the
any parameter must be the sequence with the two open registries.
</ul>
<br>
Guarantees:
<ul>
<li>-thread safe</li>
</ul>
*/
service NestedRegistry
{
// DocMerge: empty anyway
interface com::sun::star::registry::XSimpleRegistry;
// DocMerge: empty anyway
interface com::sun::star::lang::XInitialization;
};
//=============================================================================
}; }; }; };
/*=============================================================================
$Log: not supported by cvs2svn $
Revision 1.7 2002/10/03 12:44:09 mi
#94968# IDL reviews merged
Revision 1.6.2.1 2002/03/26 14:24:17 jsc
#98365# reviewed
Revision 1.6 2001/11/16 15:05:59 mi
proofing by Richard Holt
Revision 1.5 2000/12/19 14:17:15 mi
documentation sytax fixed
Revision 1.4 2000/11/08 12:28:50 mi
moved from api
Revision 1.1.1.1 2000/09/18 23:35:32 hjs
initial import
Revision 1.3 2000/09/11 11:52:37 mi
documentation merged from XML
Revision 1.1 2000/03/24 15:05:25 jsc
new
=============================================================================*/
#endif
|
