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