| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef __com_sun_star_configuration_GroupAccess_idl__ |
| #define __com_sun_star_configuration_GroupAccess_idl__ |
| |
| #ifndef __com_sun_star_configuration_HierarchyAccess_idl__ |
| #include <com/sun/star/configuration/HierarchyAccess.idl> |
| #endif |
| |
| #ifndef __com_sun_star_configuration_PropertyHierarchy_idl__ |
| #include <com/sun/star/configuration/PropertyHierarchy.idl> |
| #endif |
| |
| #ifndef __com_sun_star_beans_XPropertyState_idl__ |
| #include <com/sun/star/beans/XPropertyState.idl> |
| #endif |
| |
| #ifndef __com_sun_star_beans_XMultiPropertyState_idl__ |
| #include <com/sun/star/beans/XMultiPropertyStates.idl> |
| #endif |
| |
| //============================================================================= |
| |
| module com { module sun { module star { module configuration { |
| |
| //============================================================================= |
| /** provides access to a predefined heterogeneous group of values and nested |
| trees as part of a hierarchy. |
| |
| <p>Provides access to, and information about, its children and descendants |
| viewed either as properties or as contained elements. |
| </p> |
| |
| <p><em>Groups</em> are static collections within the hierarchy.</p> |
| |
| <p>The number and names of contained elements are fixed in advance |
| and each child may have a different type. |
| </p> |
| |
| <p>This service subsumes two alternate ways of accessing child and descendent |
| elements. These strongly overlap, supporting the basic identity |
| <code>xGroup.getPropertyValue( aName ) == xGroup.getByName( aName )</code>. |
| </p> |
| |
| @see com::sun::star::configuration::GroupElement |
| Child objects of this service generally implement service GroupElement. |
| |
| @see com::sun::star::configuration::SetAccess |
| A complementary service providing for dynamic homogeneous sets of elements. |
| |
| */ |
| published service GroupAccess |
| { |
| /** is the basic service for accessing child and descendent nodes using |
| a view of the tree as a container of values and structuring elements. |
| */ |
| service HierarchyAccess; |
| |
| /** is the basic service for accessing child and descendent nodes using |
| a view of the tree as a hierarchy of properties and subproperties. |
| |
| <p>This view is meaningful only for a static fragment of the hierarchy |
| Objects' properties may change, but not which properties they have. |
| Therefore, dynamic elements of the hierarchy (see <type>SetAccess</type>) |
| do not implement service <type>PropertyHierarchy</type>. |
| </p> |
| |
| <p>If such elements occur as properties or subproperties of an implementation, |
| it is not specified whether direct subproperty access using |
| <type scope="com::sun::star::beans">XHierarchicalPropertySet</type> or |
| <type scope="com::sun::star::beans">XMultiHierarchicalPropertySet</type> can |
| be used to access descendants of such elements. |
| </p> |
| |
| <p>Similarly, information about such descendants may not be available from |
| the <type scope="com::sun::star::beans">XHierarchicalPropertySetInfo</type> |
| the implementation provides. |
| </p> |
| |
| <p>If an implementation is part of a <em>read-only</em> view of the hierarchy, |
| all properties and subproperties will be reported as having attribute |
| <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const> set, |
| and attempts to change property values will fail. |
| </p> |
| */ |
| service PropertyHierarchy; |
| |
| /** provides access to the state of child elements of an implementation. [optional] |
| |
| <p>This interface should be present, if the hierarchy supports default values |
| for simple (non-object) properties and the group contains such properties. |
| </p> |
| |
| <p>For properties that are objects themselves, the semantic documented for |
| service <type>HierarchyAccess</type> applies. |
| </p> |
| */ |
| [optional] interface com::sun::star::beans::XPropertyState; |
| |
| /** provides access to the states of multiple child elements of |
| an implementation. [optional] |
| |
| <p>This interface should be present, if the hierarchy supports default values |
| for simple (non-object) properties and the group contains such properties. |
| </p> |
| |
| <p>For properties that are objects themselves, the semantic documented for |
| service <type>HierarchyAccess</type> applies. |
| </p> |
| */ |
| [optional] interface com::sun::star::beans::XMultiPropertyStates; |
| }; |
| |
| //============================================================================= |
| |
| }; }; }; }; |
| |
| #endif |
| |