blob: 9b564d90eabd2b91907743f24e233a40733e6e6b (
plain)
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
|
/*************************************************************************
*
* 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 __com_sun_star_configuration_SetAccess_idl__
#define __com_sun_star_configuration_SetAccess_idl__
#ifndef __com_sun_star_configuration_HierarchyAccess_idl__
#include <com/sun/star/configuration/HierarchyAccess.idl>
#endif
#ifndef __com_sun_star_configuration_SimpleSetAccess_idl__
#include <com/sun/star/configuration/SimpleSetAccess.idl>
#endif
#ifndef __com_sun_star_container_XContainer_idl__
#include <com/sun/star/container/XContainer.idl>
#endif
//=============================================================================
module com { module sun { module star { module configuration {
//=============================================================================
/** provides access to a dynamic, homogeneous set of values or nested
trees within a hierarchy.
<p>Also provides information about the template for elements.
Allows normalizing externally generated names.
</p>
<p><em>Sets</em> are dynamic containers within the hierarchy.</p>
<p>The number and names of contained elements are not fixed in advance,
but all elements have to be of one predetermined type.
</p>
@see com::sun::star::configuration::SetElement
Child objects of this service generally implement <type>SetElement</type>.
The template name returned by the child from
<member>XTemplateInstance::getTemplateName()</member>
corresponds to the name returned by the set from
<member>XTemplateContainer::getElementTemplateName()</member>.
@see com::sun::star::configuration::GroupAccess
A complementary service that provides for static heterogeneous groups of
elements within the hierarchy.
*/
published service SetAccess
{
/** is the basic service for accessing child and descendent nodes in a hierarchy.
<p>External names (from foreign namespaces) should be normalized using
<member scope="com::sun::star::util">XStringEscape::escapeString()</member>
(if available) before using them as element names.
</p>
*/
service HierarchyAccess;
/** is the basic service providing information about and access to elements
of a not necessarily hierarchical <em>set</em>.
<p>Interface <type scope="com::sun::star::configuration">XTemplateContainer</type>,
which is optional in <type>SimpleSetAccess</type> must always be implemented
in this service, if the elements are of object type. </p>
*/
service SimpleSetAccess;
/** allows attaching listeners to this node to monitor changes to the set.
<p>In this service, support for notifications is mandatory.
</p>
*/
interface com::sun::star::container::XContainer;
};
//=============================================================================
}; }; }; };
#endif
|
