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_GroupAccess_idl__
28#define __com_sun_star_configuration_GroupAccess_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_PropertyHierarchy_idl__
35#include <com/sun/star/configuration/PropertyHierarchy.idl>
36#endif
37
38#ifndef __com_sun_star_beans_XPropertyState_idl__
39#include <com/sun/star/beans/XPropertyState.idl>
40#endif
41
42#ifndef __com_sun_star_beans_XMultiPropertyState_idl__
43#include <com/sun/star/beans/XMultiPropertyStates.idl>
44#endif
45
46//=============================================================================
47
48module com { module sun { module star { module configuration {
49
50//=============================================================================
51/** provides access to a predefined heterogeneous group of values and nested
52 trees as part of a hierarchy.
53
54 <p>Provides access to, and information about, its children and descendants
55 viewed either as properties or as contained elements.
56 </p>
57
58 <p><em>Groups</em> are static collections within the hierarchy.</p>
59
60 <p>The number and names of contained elements are fixed in advance
61 and each child may have a different type.
62 </p>
63
64 <p>This service subsumes two alternate ways of accessing child and descendent
65 elements. These strongly overlap, supporting the basic identity
66 <code>xGroup.getPropertyValue( aName ) == xGroup.getByName( aName )</code>.
67 </p>
68
69 @see com::sun::star::configuration::GroupElement
70	Child objects of this service generally implement service GroupElement.
71
72 @see com::sun::star::configuration::SetAccess
73	A complementary service providing for dynamic homogeneous sets of elements.
74
75*/
76published service GroupAccess
77{
78/** is the basic service for accessing child and descendent nodes using
79 a view of the tree as a container of values and structuring elements.
80*/
81	service HierarchyAccess;
82
83/** is the basic service for accessing child and descendent nodes using
84 a view of the tree as a hierarchy of properties and subproperties.
85
86 <p>This view is meaningful only for a static fragment of the hierarchy
87 Objects' properties may change, but not which properties they have.
88 Therefore, dynamic elements of the hierarchy (see <type>SetAccess</type>)
89 do not implement service <type>PropertyHierarchy</type>.
90 </p>
91
92 <p>If such elements occur as properties or subproperties of an implementation,
93 it is not specified whether direct subproperty access using
94 <type scope="com::sun::star::beans">XHierarchicalPropertySet</type> or
95 <type scope="com::sun::star::beans">XMultiHierarchicalPropertySet</type> can
96 be used to access descendants of such elements.
97 </p>
98
99 <p>Similarly, information about such descendants may not be available from
100 the <type scope="com::sun::star::beans">XHierarchicalPropertySetInfo</type>
101 the implementation provides.
102 </p>
103
104 <p>If an implementation is part of a <em>read-only</em> view of the hierarchy,
105 all properties and subproperties will be reported as having attribute
106 <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const> set,
107 and attempts to change property values will fail.
108 </p>
109*/
110	service PropertyHierarchy;
111
112/** provides access to the state of child elements of an implementation. [optional]
113
114 <p>This interface should be present, if the hierarchy supports default values
115 for simple (non-object) properties and the group contains such properties.
116 </p>
117
118 <p>For properties that are objects themselves, the semantic documented for
119 service <type>HierarchyAccess</type> applies.
120 </p>
121 */
122	[optional] interface com::sun::star::beans::XPropertyState;
123
124/** provides access to the states of multiple child elements of
125 an implementation. [optional]
126
127 <p>This interface should be present, if the hierarchy supports default values
128 for simple (non-object) properties and the group contains such properties.
129 </p>
130
131 <p>For properties that are objects themselves, the semantic documented for
132 service <type>HierarchyAccess</type> applies.
133 </p>
134*/
135	[optional] interface com::sun::star::beans::XMultiPropertyStates;
136};
137
138//=============================================================================
139
140}; }; }; };
141
142#endif
143
144