1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_configuration_GroupAccess_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_configuration_GroupAccess_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_configuration_HierarchyAccess_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/configuration/HierarchyAccess.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir#ifndef __com_sun_star_configuration_PropertyHierarchy_idl__ 35*cdf0e10cSrcweir#include <com/sun/star/configuration/PropertyHierarchy.idl> 36*cdf0e10cSrcweir#endif 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertyState_idl__ 39*cdf0e10cSrcweir#include <com/sun/star/beans/XPropertyState.idl> 40*cdf0e10cSrcweir#endif 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir#ifndef __com_sun_star_beans_XMultiPropertyState_idl__ 43*cdf0e10cSrcweir#include <com/sun/star/beans/XMultiPropertyStates.idl> 44*cdf0e10cSrcweir#endif 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir//============================================================================= 47*cdf0e10cSrcweir 48*cdf0e10cSrcweirmodule com { module sun { module star { module configuration { 49*cdf0e10cSrcweir 50*cdf0e10cSrcweir//============================================================================= 51*cdf0e10cSrcweir/** provides access to a predefined heterogeneous group of values and nested 52*cdf0e10cSrcweir trees as part of a hierarchy. 53*cdf0e10cSrcweir 54*cdf0e10cSrcweir <p>Provides access to, and information about, its children and descendants 55*cdf0e10cSrcweir viewed either as properties or as contained elements. 56*cdf0e10cSrcweir </p> 57*cdf0e10cSrcweir 58*cdf0e10cSrcweir <p><em>Groups</em> are static collections within the hierarchy.</p> 59*cdf0e10cSrcweir 60*cdf0e10cSrcweir <p>The number and names of contained elements are fixed in advance 61*cdf0e10cSrcweir and each child may have a different type. 62*cdf0e10cSrcweir </p> 63*cdf0e10cSrcweir 64*cdf0e10cSrcweir <p>This service subsumes two alternate ways of accessing child and descendent 65*cdf0e10cSrcweir elements. These strongly overlap, supporting the basic identity 66*cdf0e10cSrcweir <code>xGroup.getPropertyValue( aName ) == xGroup.getByName( aName )</code>. 67*cdf0e10cSrcweir </p> 68*cdf0e10cSrcweir 69*cdf0e10cSrcweir @see com::sun::star::configuration::GroupElement 70*cdf0e10cSrcweir Child objects of this service generally implement service GroupElement. 71*cdf0e10cSrcweir 72*cdf0e10cSrcweir @see com::sun::star::configuration::SetAccess 73*cdf0e10cSrcweir A complementary service providing for dynamic homogeneous sets of elements. 74*cdf0e10cSrcweir 75*cdf0e10cSrcweir*/ 76*cdf0e10cSrcweirpublished service GroupAccess 77*cdf0e10cSrcweir{ 78*cdf0e10cSrcweir/** is the basic service for accessing child and descendent nodes using 79*cdf0e10cSrcweir a view of the tree as a container of values and structuring elements. 80*cdf0e10cSrcweir*/ 81*cdf0e10cSrcweir service HierarchyAccess; 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir/** is the basic service for accessing child and descendent nodes using 84*cdf0e10cSrcweir a view of the tree as a hierarchy of properties and subproperties. 85*cdf0e10cSrcweir 86*cdf0e10cSrcweir <p>This view is meaningful only for a static fragment of the hierarchy 87*cdf0e10cSrcweir Objects' properties may change, but not which properties they have. 88*cdf0e10cSrcweir Therefore, dynamic elements of the hierarchy (see <type>SetAccess</type>) 89*cdf0e10cSrcweir do not implement service <type>PropertyHierarchy</type>. 90*cdf0e10cSrcweir </p> 91*cdf0e10cSrcweir 92*cdf0e10cSrcweir <p>If such elements occur as properties or subproperties of an implementation, 93*cdf0e10cSrcweir it is not specified whether direct subproperty access using 94*cdf0e10cSrcweir <type scope="com::sun::star::beans">XHierarchicalPropertySet</type> or 95*cdf0e10cSrcweir <type scope="com::sun::star::beans">XMultiHierarchicalPropertySet</type> can 96*cdf0e10cSrcweir be used to access descendants of such elements. 97*cdf0e10cSrcweir </p> 98*cdf0e10cSrcweir 99*cdf0e10cSrcweir <p>Similarly, information about such descendants may not be available from 100*cdf0e10cSrcweir the <type scope="com::sun::star::beans">XHierarchicalPropertySetInfo</type> 101*cdf0e10cSrcweir the implementation provides. 102*cdf0e10cSrcweir </p> 103*cdf0e10cSrcweir 104*cdf0e10cSrcweir <p>If an implementation is part of a <em>read-only</em> view of the hierarchy, 105*cdf0e10cSrcweir all properties and subproperties will be reported as having attribute 106*cdf0e10cSrcweir <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const> set, 107*cdf0e10cSrcweir and attempts to change property values will fail. 108*cdf0e10cSrcweir </p> 109*cdf0e10cSrcweir*/ 110*cdf0e10cSrcweir service PropertyHierarchy; 111*cdf0e10cSrcweir 112*cdf0e10cSrcweir/** provides access to the state of child elements of an implementation. [optional] 113*cdf0e10cSrcweir 114*cdf0e10cSrcweir <p>This interface should be present, if the hierarchy supports default values 115*cdf0e10cSrcweir for simple (non-object) properties and the group contains such properties. 116*cdf0e10cSrcweir </p> 117*cdf0e10cSrcweir 118*cdf0e10cSrcweir <p>For properties that are objects themselves, the semantic documented for 119*cdf0e10cSrcweir service <type>HierarchyAccess</type> applies. 120*cdf0e10cSrcweir </p> 121*cdf0e10cSrcweir */ 122*cdf0e10cSrcweir [optional] interface com::sun::star::beans::XPropertyState; 123*cdf0e10cSrcweir 124*cdf0e10cSrcweir/** provides access to the states of multiple child elements of 125*cdf0e10cSrcweir an implementation. [optional] 126*cdf0e10cSrcweir 127*cdf0e10cSrcweir <p>This interface should be present, if the hierarchy supports default values 128*cdf0e10cSrcweir for simple (non-object) properties and the group contains such properties. 129*cdf0e10cSrcweir </p> 130*cdf0e10cSrcweir 131*cdf0e10cSrcweir <p>For properties that are objects themselves, the semantic documented for 132*cdf0e10cSrcweir service <type>HierarchyAccess</type> applies. 133*cdf0e10cSrcweir </p> 134*cdf0e10cSrcweir*/ 135*cdf0e10cSrcweir [optional] interface com::sun::star::beans::XMultiPropertyStates; 136*cdf0e10cSrcweir}; 137*cdf0e10cSrcweir 138*cdf0e10cSrcweir//============================================================================= 139*cdf0e10cSrcweir 140*cdf0e10cSrcweir}; }; }; }; 141*cdf0e10cSrcweir 142*cdf0e10cSrcweir#endif 143*cdf0e10cSrcweir 144