1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_configuration_HierarchyElement_idl__
24#define __com_sun_star_configuration_HierarchyElement_idl__
25
26#ifndef __com_sun_star_container_XNamed_idl__
27#include <com/sun/star/container/XNamed.idl>
28#endif
29
30#ifndef __com_sun_star_container_XHierarchicalName_idl__
31#include <com/sun/star/container/XHierarchicalName.idl>
32#endif
33
34#ifndef __com_sun_star_beans_XProperty_idl__
35#include <com/sun/star/beans/XProperty.idl>
36#endif
37
38#ifndef __com_sun_star_beans_XPropertyWithState_idl__
39#include <com/sun/star/beans/XPropertyWithState.idl>
40#endif
41
42#ifndef __com_sun_star_container_XChild_idl__
43#include <com/sun/star/container/XChild.idl>
44#endif
45
46//=============================================================================
47
48module com { module sun { module star { module configuration {
49
50//=============================================================================
51/** provides information about an element within a hierarchy.
52
53 <p>The local name and the full hierarchical name can be retrieved.
54 Attributes detailing the role of the element can be queried.
55 The state of the element (regarding defaults) can be accessed.
56 </p>
57
58 <p>Implementations of this service usually also implement
59 service <type>HierarchyAccess</type>, which concerns the complementary role
60 of providing access to subelements of the hierarchy.
61 </p>
62*/
63published service HierarchyElement
64{
65/** provides the complete hierarchical name of this element
66 within the hierarchy tree.
67*/
68	interface com::sun::star::container::XHierarchicalName;
69
70/** provides the local name of this element within its parent.
71
72 <p><em>Renaming an element is generally not supported.</em></p>
73*/
74	interface com::sun::star::container::XNamed;
75
76/** provides a property descriptor for this element.[optional]
77
78 <p>This interface may be missing, if the hierarchy supports no traits that are
79 described by <type scope="com::sun::star::beans">PropertyAttribute</type>
80 values.
81 </p>
82
83 <p>If the parent of this object implements
84 <type scope="com::sun::star::beans">XPropertySetInfo</type>, then this returns
85 the same <type scope="com::sun::star::beans">Property</type> as the
86 <type scope="com::sun::star::beans">XPropertySetInfo</type> of the parent.
87 </p>
88*/
89	[optional] interface com::sun::star::beans::XProperty;
90
91/** provides access to the default state of this element. [optional]
92
93 <p>This interface may be missing, if the hierarchy supports access to
94 a default state and values only for simple values or not at all.
95 </p>
96
97 <p>If the parent of this object implements
98 <type scope="com::sun::star::beans">XPropertyState</type>, then members
99 of this interface have the same effect as corresponding members of the parent.
100 </p>
101
102 <p>If an implementation is part of a <em>read-only</em> view of the hierarchy,
103 attempts to change property states will fail.
104 </p>
105*/
106	[optional] interface com::sun::star::beans::XPropertyWithState;
107
108/** provides access to the parent of this element [optional].
109
110 <p>This interface may be missing if this object is not obtained
111 as a child or descendant of another tree node, for example, directly from a factory or provider.
112 </p>
113
114 <p><member scope="com::sun::star::container">XChild::getParent()</member>
115 returns NULL, if this object is currently not contained in another node.
116 </p>
117
118 <p><em>Setting a different parent is, generally, not supported.</em></p>
119*/
120	[optional] interface com::sun::star::container::XChild;
121
122};
123
124//=============================================================================
125
126}; }; }; };
127
128#endif
129