:: 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
Objects' 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 © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.