Overview | Module | Use | Devguide | Index

Services' Summary | Interfaces' Summary | Properties' Summary | Services' Details | Interfaces' Details | Properties' Details

:: com :: sun :: star :: configuration ::
service GroupAccess
Description provides access to a predefined heterogeneous group of values and nested trees as part of a hierarchy. Provides access to, and information about, its children and descendants viewed either as properties or as contained elements. Groups are static collections within the hierarchy. The number and names of contained elements are fixed in advance and each child may have a different type. This service subsumes two alternate ways of accessing child and descendent elements. These strongly overlap, supporting the basic identity `xGroup.getPropertyValue( aName ) == xGroup.getByName( aName )`. See also GroupElement Child objects of this service generally implement service GroupElement. See also SetAccess A complementary service providing for dynamic homogeneous sets of elements.

Included Services - Summary
HierarchyAccess | is the basic service for accessing child and descendent nodes using a view of the tree as a container of values and structuring elements.
PropertyHierarchy | is the basic service for accessing child and descendent nodes using a view of the tree as a hierarchy of properties and subproperties. (details)

Exported Interfaces - Summary
::com::sun::star::beans::XPropertyState | provides access to the state of child elements of an implementation. [optional] (details)
::com::sun::star::beans::XMultiPropertyStates | provides access to the states of multiple child elements of an implementation. [optional] (details)

Included Services - Details
HierarchyAccess
Description is the basic service for accessing child and descendent nodes using a view of the tree as a container of values and structuring elements.
PropertyHierarchy
Description is the basic service for accessing child and descendent nodes using a view of the tree as a hierarchy of properties and subproperties. This view is meaningful only for a static fragment of the hierarchy Object's properties may change, but not which properties they have. Therefore, dynamic elements of the hierarchy (see SetAccess) do not implement service PropertyHierarchy. If such elements occur as properties or subproperties of an implementation, it is not specified whether direct subproperty access using ::com::sun::star::beans::XHierarchicalPropertySet or ::com::sun::star::beans::XMultiHierarchicalPropertySet can be used to access descendants of such elements. Similarly, information about such descendants may not be available from the ::com::sun::star::beans::XHierarchicalPropertySetInfo the implementation provides. If an implementation is part of a read-only view of the hierarchy, all properties and subproperties will be reported as having attribute PropertyAttribute::READONLY set, and attempts to change property values will fail.

Exported Interfaces - Details
::com::sun::star::beans::XPropertyState
Usage Restrictions optional Description provides access to the state of child elements of an implementation. [optional] This interface should be present, if the hierarchy supports default values for simple (non-object) properties and the group contains such properties. For properties that are objects themselves, the semantic documented for service HierarchyAccess applies.
::com::sun::star::beans::XMultiPropertyStates
Usage Restrictions optional Description provides access to the states of multiple child elements of an implementation. [optional] This interface should be present, if the hierarchy supports default values for simple (non-object) properties and the group contains such properties. For properties that are objects themselves, the semantic documented for service HierarchyAccess applies.

Top of Page

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.