1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_configuration_GroupAccess_idl__ 24cdf0e10cSrcweir#define __com_sun_star_configuration_GroupAccess_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_configuration_HierarchyAccess_idl__ 27cdf0e10cSrcweir#include <com/sun/star/configuration/HierarchyAccess.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_configuration_PropertyHierarchy_idl__ 31cdf0e10cSrcweir#include <com/sun/star/configuration/PropertyHierarchy.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertyState_idl__ 35cdf0e10cSrcweir#include <com/sun/star/beans/XPropertyState.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_beans_XMultiPropertyState_idl__ 39cdf0e10cSrcweir#include <com/sun/star/beans/XMultiPropertyStates.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir//============================================================================= 43cdf0e10cSrcweir 44cdf0e10cSrcweirmodule com { module sun { module star { module configuration { 45cdf0e10cSrcweir 46cdf0e10cSrcweir//============================================================================= 47cdf0e10cSrcweir/** provides access to a predefined heterogeneous group of values and nested 48cdf0e10cSrcweir trees as part of a hierarchy. 49cdf0e10cSrcweir 50cdf0e10cSrcweir <p>Provides access to, and information about, its children and descendants 51cdf0e10cSrcweir viewed either as properties or as contained elements. 52cdf0e10cSrcweir </p> 53cdf0e10cSrcweir 54cdf0e10cSrcweir <p><em>Groups</em> are static collections within the hierarchy.</p> 55cdf0e10cSrcweir 56cdf0e10cSrcweir <p>The number and names of contained elements are fixed in advance 57cdf0e10cSrcweir and each child may have a different type. 58cdf0e10cSrcweir </p> 59cdf0e10cSrcweir 60cdf0e10cSrcweir <p>This service subsumes two alternate ways of accessing child and descendent 61cdf0e10cSrcweir elements. These strongly overlap, supporting the basic identity 62cdf0e10cSrcweir <code>xGroup.getPropertyValue( aName ) == xGroup.getByName( aName )</code>. 63cdf0e10cSrcweir </p> 64cdf0e10cSrcweir 65cdf0e10cSrcweir @see com::sun::star::configuration::GroupElement 66cdf0e10cSrcweir Child objects of this service generally implement service GroupElement. 67cdf0e10cSrcweir 68cdf0e10cSrcweir @see com::sun::star::configuration::SetAccess 69cdf0e10cSrcweir A complementary service providing for dynamic homogeneous sets of elements. 70cdf0e10cSrcweir 71cdf0e10cSrcweir*/ 72cdf0e10cSrcweirpublished service GroupAccess 73cdf0e10cSrcweir{ 74cdf0e10cSrcweir/** is the basic service for accessing child and descendent nodes using 75cdf0e10cSrcweir a view of the tree as a container of values and structuring elements. 76cdf0e10cSrcweir*/ 77cdf0e10cSrcweir service HierarchyAccess; 78cdf0e10cSrcweir 79cdf0e10cSrcweir/** is the basic service for accessing child and descendent nodes using 80cdf0e10cSrcweir a view of the tree as a hierarchy of properties and subproperties. 81cdf0e10cSrcweir 82cdf0e10cSrcweir <p>This view is meaningful only for a static fragment of the hierarchy 83cdf0e10cSrcweir Objects' properties may change, but not which properties they have. 84cdf0e10cSrcweir Therefore, dynamic elements of the hierarchy (see <type>SetAccess</type>) 85cdf0e10cSrcweir do not implement service <type>PropertyHierarchy</type>. 86cdf0e10cSrcweir </p> 87cdf0e10cSrcweir 88cdf0e10cSrcweir <p>If such elements occur as properties or subproperties of an implementation, 89cdf0e10cSrcweir it is not specified whether direct subproperty access using 90cdf0e10cSrcweir <type scope="com::sun::star::beans">XHierarchicalPropertySet</type> or 91cdf0e10cSrcweir <type scope="com::sun::star::beans">XMultiHierarchicalPropertySet</type> can 92cdf0e10cSrcweir be used to access descendants of such elements. 93cdf0e10cSrcweir </p> 94cdf0e10cSrcweir 95cdf0e10cSrcweir <p>Similarly, information about such descendants may not be available from 96cdf0e10cSrcweir the <type scope="com::sun::star::beans">XHierarchicalPropertySetInfo</type> 97cdf0e10cSrcweir the implementation provides. 98cdf0e10cSrcweir </p> 99cdf0e10cSrcweir 100cdf0e10cSrcweir <p>If an implementation is part of a <em>read-only</em> view of the hierarchy, 101cdf0e10cSrcweir all properties and subproperties will be reported as having attribute 102cdf0e10cSrcweir <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const> set, 103cdf0e10cSrcweir and attempts to change property values will fail. 104cdf0e10cSrcweir </p> 105cdf0e10cSrcweir*/ 106cdf0e10cSrcweir service PropertyHierarchy; 107cdf0e10cSrcweir 108cdf0e10cSrcweir/** provides access to the state of child elements of an implementation. [optional] 109cdf0e10cSrcweir 110cdf0e10cSrcweir <p>This interface should be present, if the hierarchy supports default values 111cdf0e10cSrcweir for simple (non-object) properties and the group contains such properties. 112cdf0e10cSrcweir </p> 113cdf0e10cSrcweir 114cdf0e10cSrcweir <p>For properties that are objects themselves, the semantic documented for 115cdf0e10cSrcweir service <type>HierarchyAccess</type> applies. 116cdf0e10cSrcweir </p> 117cdf0e10cSrcweir */ 118cdf0e10cSrcweir [optional] interface com::sun::star::beans::XPropertyState; 119cdf0e10cSrcweir 120cdf0e10cSrcweir/** provides access to the states of multiple child elements of 121cdf0e10cSrcweir an implementation. [optional] 122cdf0e10cSrcweir 123cdf0e10cSrcweir <p>This interface should be present, if the hierarchy supports default values 124cdf0e10cSrcweir for simple (non-object) properties and the group contains such properties. 125cdf0e10cSrcweir </p> 126cdf0e10cSrcweir 127cdf0e10cSrcweir <p>For properties that are objects themselves, the semantic documented for 128cdf0e10cSrcweir service <type>HierarchyAccess</type> applies. 129cdf0e10cSrcweir </p> 130cdf0e10cSrcweir*/ 131cdf0e10cSrcweir [optional] interface com::sun::star::beans::XMultiPropertyStates; 132cdf0e10cSrcweir}; 133cdf0e10cSrcweir 134cdf0e10cSrcweir//============================================================================= 135cdf0e10cSrcweir 136cdf0e10cSrcweir}; }; }; }; 137cdf0e10cSrcweir 138cdf0e10cSrcweir#endif 139cdf0e10cSrcweir 140