1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_configuration_SetAccess_idl__
28#define __com_sun_star_configuration_SetAccess_idl__
29
30#ifndef __com_sun_star_configuration_HierarchyAccess_idl__
31#include <com/sun/star/configuration/HierarchyAccess.idl>
32#endif
33
34#ifndef __com_sun_star_configuration_SimpleSetAccess_idl__
35#include <com/sun/star/configuration/SimpleSetAccess.idl>
36#endif
37
38#ifndef __com_sun_star_container_XContainer_idl__
39#include <com/sun/star/container/XContainer.idl>
40#endif
41
42//=============================================================================
43
44module com { module sun { module star { module configuration {
45
46//=============================================================================
47/** provides access to a dynamic, homogeneous set of values or nested
48 trees within a hierarchy.
49
50 <p>Also provides information about the template for elements.
51 Allows normalizing externally generated names.
52 </p>
53
54 <p><em>Sets</em> are dynamic containers within the hierarchy.</p>
55
56 <p>The number and names of contained elements are not fixed in advance,
57 but all elements have to be of one predetermined type.
58 </p>
59
60 @see com::sun::star::configuration::SetElement
61	Child objects of this service generally implement <type>SetElement</type>.
62	The template name returned by the child from
63	<member>XTemplateInstance::getTemplateName()</member>
64	corresponds to the name returned by the set from
65	<member>XTemplateContainer::getElementTemplateName()</member>.
66
67 @see com::sun::star::configuration::GroupAccess
68	A complementary service that provides for static heterogeneous groups of
69	elements within the hierarchy.
70
71*/
72published service SetAccess
73{
74/** is the basic service for accessing child and descendent nodes in a hierarchy.
75
76 <p>External names (from foreign namespaces) should be normalized using
77 <member scope="com::sun::star::util">XStringEscape::escapeString()</member>
78 (if available) before using them as element names.
79 </p>
80*/
81	service HierarchyAccess;
82
83/** is the basic service providing information about and access to elements
84 of a not necessarily hierarchical <em>set</em>.
85
86 <p>Interface <type scope="com::sun::star::configuration">XTemplateContainer</type>,
87 which is optional in <type>SimpleSetAccess</type> must always be implemented
88 in this service, if the elements are of object type.  </p>
89*/
90	service SimpleSetAccess;
91
92/** allows attaching listeners to this node to monitor changes to the set.
93
94 <p>In this service, support for notifications is mandatory.
95 </p>
96*/
97	interface com::sun::star::container::XContainer;
98
99};
100
101//=============================================================================
102
103}; }; }; };
104
105#endif
106