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
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
|
/* -*- 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 __com_sun_star_configuration_backend_XLayerHandler_idl__
#define __com_sun_star_configuration_backend_XLayerHandler_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/configuration/backend/TemplateIdentifier.idl>
#include <com/sun/star/configuration/backend/MalformedDataException.idl>
#include <com/sun/star/lang/WrappedTargetException.idl>
module com { module sun { module star { module configuration { module backend {
/** receives a description of a configuration layer
as a sequence of events.
@since OOo 1.1.2
*/
published interface XLayerHandler: ::com::sun::star::uno::XInterface
{
/** receives notification that a layer description is started
for a component.
<p> Subsequent calls describe the contents of the layer
until a matching call to XLayerHandler::endLayer()
is encountered.
</p>
@throws com::sun::star::configuration::backend::MalformedDataException
if there is an unfinished layer in progress
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
void startLayer( )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a layer description is complete.
<p> Must match a previous call to XLayerHandler::startLayer().
</p>
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if invalid data is detected in the layer</li>
<li>if there is a unfinished subnode in progress</li>
<li>if no layer is started at all</li>
<li>if the layer tries to override read-only or final data</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
void endLayer( )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a description of a node override is started.
<p> Subsequent calls describe overrides to properties and members
or items of the node until a matching call to
XLayerHandler::endNode()is encountered.
</p>
@param aName
specifies the name of the node.
@param aAttributes
specifies attribute values to be applied to the node.
<p> The value is a combination of
NodeAttribute flags.
</p>
<p> The attributes are combined cumulatively with those
set on lower layers.
</p>
@param bClear
if `TRUE`, specifies that the node should be cleared to an empty
state by removing all non-mandatory children from lower layers prior
to applying the overrides.
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there isn't a layer in progress</li>
<li>if there already was a change to that node</li>
<li>if there is no node with that name</li>
<li>if the node is marked read-only in a lower layer</li>
<li>if the name is not a valid node name</li>
<li>if the attributes are not valid for the node</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
@see com::sun::star::configuration::backend::NodeAttribute
*/
void overrideNode( [in] string aName,
[in] short aAttributes,
[in] boolean bClear )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a new item is started.
<p> The current node must be a set and
a preexisting item (if any) must be removable.
</p>
<p> The new item will be created from the default template
of the set.
</p>
<p> Subsequent calls describe the difference from the template
of properties and members or items of the node until
a matching call to XLayerHandler::endNode()
is encountered.
</p>
@param aName
specifies the name of the item.
@param aAttributes
specifies attribute values to be applied to the new node.
<p> The value is a combination of
NodeAttribute flags. Note that
NodeAttribute::FUSE has an impact on the
semantics of this method.
</p>
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there isn't a set node in progress currently</li>
<li>if there already was a change to a node of that name</li>
<li>if the template for the new node is not found</li>
<li>if an item of that name on a lower layer is not removable</li>
<li>if the name is not a valid item name</li>
<li>if the attributes are not valid for the node</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
@see com::sun::star::configuration::backend::NodeAttribute
*/
void addOrReplaceNode( [in] string aName,
[in] short aAttributes )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a new item based on a particular template
is started.
<p> The current node must be a set and
a preexisting item (if any) must be removable.
</p>
<p> Subsequent calls describe the difference from the template
of properties and members or items of the node until
a matching call to XLayerHandler::endNode()
is encountered.
</p>
@param aName
specifies the name of the item.
@param aTemplate
specifies the template to use for the new node
@param aAttributes
specifies attribute values to be applied to the new node.
<p> The value is a combination of
NodeAttribute flags. Note that
NodeAttribute::FUSE has an impact on the
semantics of this method.
</p>
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there isn't a set node in progress currently</li>
<li>if there already was a change to a node of that name</li>
<li>if the template for the new node is not found</li>
<li>if the template is not a valid item type for the containing set</li>
<li>if an item of that name on a lower layer is not removable</li>
<li>if the name is not a valid item name</li>
<li>if the attributes are not valid for the node</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
@see com::sun::star::configuration::backend::NodeAttribute
*/
void addOrReplaceNodeFromTemplate( [in] string aName,
[in] TemplateIdentifier aTemplate,
[in] short aAttributes )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a node description is complete.
<p> Must match the last open call to
XLayerHandler::overrideNode(),
XLayerHandler::addOrReplaceNode() or
XLayerHandler::addOrReplaceNodeFromTemplate().
</p>
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if invalid data is detected in the node</li>
<li>if no node is started at all</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
void endNode( )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a node is dropped from a set.
<p> The current node must be a set and
the item must be removable.
</p>
@param aName
specifies the name of the node.
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there isn't a set node in progress currently</li>
<li>if there already was a change to a node of that name</li>
<li>if there is no item with that name</li>
<li>if the item is not removable</li>
<li>if the name is not a valid node name</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
void dropNode( [in] string aName )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that an existing property is modified.
<p> Subsequent calls describe new value(s) for the property until a
matching call to XLayerHandler::endProperty()
is encountered.
</p>
@param aName
specifies the name of the property.
@param aAttributes
specifies the new attributes of the property.
<p> The value is a combination of
NodeAttribute flags.
</p>
<p> The attributes are combined cumulatively with those
set on lower layers.
</p>
@param aType
specifies the type of the property.
<p> This must be the same type as is already defined in the schema
or lower layers, unless the previous type was unspecified
(as indicated by
com::sun::star::uno::TypeClass::ANY.)
</p>
<p> A `VOID` type indicates that the type is unspecified
in this layer.
In this case any subsequent value may be of a generic type
(e.g. `string` or - for list values -
`string[]`.) Such values may be
converted to the type defined in the schema by
the implementation.
</p>
@param bClear
if `TRUE`, specifies that the property should be cleared to an empty
state by discarding all values from lower layers prior
to applying the overrides.
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there isn't a group or extensible node in progress currently</li>
<li>if there already was a change to a property of that name</li>
<li>if there is no property with that name</li>
<li>if the property is read-only</li>
<li>if the type does not match the type of the property</li>
<li>if a type is missing and cannot be determined otherwise</li>
<li>if the name is not a valid property name</li>
<li>if the attributes are not valid for the property</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
@see com::sun::star::configuration::backend::NodeAttribute
*/
void overrideProperty( [in] string aName,
[in] short aAttributes,
[in] type aType,
[in] boolean bClear )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that the value of the current property
is overridden.
@param aValue
specifies the new value of the property.
<p> The value must match the type of the current property.
If the property does not have the
SchemaAttribute::REQUIRED flag set,
the value can be `VOID`.
</p>
<p> If the current property is localized, this value applies
to the default locale.
</p>
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there isn't a property in progress currently</li>
<li>if there already was a change to the value of that property</li>
<li>if the value does not have the proper type</li>
<li>if the value is not valid for the property</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
@see com::sun::star::configuration::backend::NodeAttribute
*/
void setPropertyValue( [in] any aValue )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that the value of the current localized property
is overridden for a specific locale .
@param aValue
specifies the new value of the property.
<p> The value must match the type of the current property.
If the property does not have the
SchemaAttribute::REQUIRED flag set,
the value can be `VOID`.
</p>
@param aLocale
specifies the locale this value should apply to.
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there isn't a property in progress currently</li>
<li>if the current property isn't localized</li>
<li>if there already was a change to the property for that locale</li>
<li>if the value does not have the proper type</li>
<li>if the value is not valid for the property</li>
<li>if the locale is not a valid locale</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
@see com::sun::star::configuration::backend::NodeAttribute
*/
void setPropertyValueForLocale([in] any aValue,
[in] string aLocale )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a property description is complete.
<p> Must match an open call to
XLayerHandler::overrideProperty(),
</p>
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if invalid data is detected in the property</li>
<li>if no property is started at all</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
void endProperty( )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a property having a `VOID` value is added
to the current node.
<p> The current node must be extensible.
</p>
@param aName
specifies the name of the new property.
@param aAttributes
specifies the attributes of the new property.
<p> The value is a combination of
NodeAttribute flags and may also contain the
SchemaAttribute::REQUIRED flag.
</p>
<p> NodeAttribute::MANDATORY need not be set,
as dynamically added properties always are mandatory
in subsequent layers.
</p>
@param aType
specifies the type of the new property.
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there isn't an extensible node in progress currently</li>
<li>if a property with that name already exists</li>
<li>if the specified type is not allowed for a property</li>
<li>if the name is not a valid property name</li>
<li><li>if the attributes are not valid for the property</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
@see com::sun::star::configuration::backend::SchemaAttribute
*/
void addProperty( [in] string aName,
[in] short aAttributes,
[in] type aType )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a property having a non-`VOID` value
is added to the current node.
<p> The current node must be extensible.
</p>
@param aName
specifies the name of the new property.
@param aAttributes
specifies the attributes of the new property.
<p> The value is a combination of
NodeAttribute flags and may also contain the
SchemaAttribute::REQUIRED flag.
</p>
</p>
<p> NodeAttribute::MANDATORY need not be set,
as dynamic properties always are mandatory
in subsequent layers.
</p>
@param aValue
specifies the value of the new property.
<p> The value also determines the type.
Therefore the value must not be `VOID`.
</p>
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there isn't an extensible node in progress currently</li>
<li>if a property with that name already exists</li>
<li>if the type of the value is not an allowed type
or if the value is `VOID`</li>
<li>if the name is not a valid property name</li>
<li>if the value is not valid for the property</li>
<li>if the attributes are not valid for the property</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
@see com::sun::star::configuration::backend::SchemaAttribute
*/
void addPropertyWithValue( [in] string aName,
[in] short aAttributes,
[in] any aValue )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
};
}; }; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
