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
|
/* -*- 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_SimpleSetUpdate_idl__
#define __com_sun_star_configuration_SimpleSetUpdate_idl__
#include <com/sun/star/configuration/SimpleSetAccess.idl>
#include <com/sun/star/container/XNameContainer.idl>
#include <com/sun/star/lang/XSingleServiceFactory.idl>
#include <com/sun/star/lang/XMultiServiceFactory.idl>
module com { module sun { module star { module configuration {
/** provides write access to a dynamic, homogeneous, non-hierarchical set of
values or objects.
<p>Allows adding and removing elements.
Helps create new elements to be added.
</p>
<p>This service extends SimpleSetAccess to support
modifying the container. Any child objects shall in turn support
modifying access.
</p>
*/
published service SimpleSetUpdate
{
/** is the basic service providing read access to a (not necessarily
hierarchical) <em>set</em>.
*/
service SimpleSetAccess;
/** allows inserting, removing, and replacing elements.
<p>This interface extends the interface
com::sun::star::container::XNameAccess supported
by service SimpleSetAccess to allow modifying the container.
</p>
<p>If available, changes can be observed by registering a listener with interface
com::sun::star::container::XContainer.
</p>
<p>If the elements of this set are of simple type (the type returned by
com::sun::star::container::XElementAccess::getElementType()
is not an interface type), then values of that type can directly be passed to
com::sun::star::container::XNameContainer::insertByName()
and
com::sun::star::container::XNameContainer::replaceByName().
</p>
<p>Otherwise new elements have to be constructed to match the type
prescribed by the element template of this set. Such elements can be created
using interfaces com::sun::star::lang::XSingleServiceFactory
and, if supported, com::sun::star::lang::XMultiServiceFactory.
</p>
<p>Objects to be inserted must not be contained in any set at the time of
insertion. com::sun::star::container::XChild::getParent()
must return `NULL`. If a name had been assigned to the object prior to insertion
(using com::sun::star::container::XNamed::setName()
or by other means), this name is ignored and will be lost.
After insertion the name of the object is the name that was used as argument
to com::sun::star::container::XNameContainer::insertByName()
or com::sun::star::container::XNameContainer::replaceByName().
</p>
<p>Objects that are removed using
com::sun::star::container::XNameContainer::removeByName()
or replaced using
com::sun::star::container::XNameContainer::replaceByName()
remain valid and can be reinserted into a set supporting the same template and
even under a different name.
</p>
<p>An implementation need not support insertion of objects that were not
obtained in one of the ways described above. If it does, the implementation
must reject elements that do not have the correct structure as described
by the template.
</p>
*/
interface com::sun::star::container::XNameContainer;
/** allows creating an object that can be inserted into this set. [conditional]
<p>This interface shall be implemented by an implementation,
if and only if the element type of the set, as returned by
com::sun::star::container::XElementAccess::getElementType(),
is an object type, such as an interface.
</p>
<p>Using com::sun::star::lang::XSingleServiceFactory::createInstance()
an instance of the element template of this set is created. If the set
supports multiple templates or variations of the basic template, a default
variant of the basic template is instantiated. If an implementation supports
variations, they may be specified by passing arguments to
com::sun::star::lang::XSingleServiceFactory::createInstanceWithArguments().
There are no predefined arguments for all versions of this service.
</p>
<p>The object created is not contained in the set and does not have a name yet.
It may subsequently be inserted into the set and named using
com::sun::star::container::XNameContainer::insertByName()
or
com::sun::star::container::XNameContainer::replaceByName().
</p>
*/
[optional] interface com::sun::star::lang::XSingleServiceFactory;
/** allows creating various objects that can be inserted into this set. [optional]
<p>This interface may be implemented by an implementation of
service SetUpdate to support creating elements from other than
the basic element template. An example of this would be an
implementation that supports inheritance, allowing the use of
templates derived from the basic template by extension.
</p>
<p>This interface may only be implemented if the element type of the set
(as returned by
com::sun::star::container::XElementAccess::getElementType())
is an object type, such as an interface. An implementation should also implement
interface XTemplateContainer which is optional in this service.
</p>
<p>The service identifier argument passed
to com::sun::star::lang::XMultiServiceFactory::createInstance()
or com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments()
names the template to be instantiated or otherwise identifies the structure
to be built. The implementation must at least support using the template
name obtained from XTemplateContainer::getElementTemplateName()
as a service identifier, in which case the result shall be the same as if
the corresponding member of com::sun::star::lang::XSingleServiceFactory
had been called.
</p>
*/
[optional] interface com::sun::star::lang::XMultiServiceFactory;
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
