LibreOffice
LibreOffice 24.8 SDK API Reference
|
provides access to a predefined heterogeneous group of values and nested trees as part of a hierarchy. More...
import <GroupAccess.idl;
Included Services | |
service | 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. | |
service | PropertyHierarchy |
is the basic service for accessing child and descendent nodes using a view of the tree as a hierarchy of properties and subproperties. | |
Exported Interfaces | |
interface | com::sun::star::beans::XPropertyState |
provides access to the state of child elements of an implementation. | |
interface | com::sun::star::beans::XMultiPropertyStates |
provides access to the states of multiple child elements of an implementation. | |
![]() | |
interface | com::sun::star::container::XNameAccess |
allows access to immediate children of this node. | |
interface | com::sun::star::container::XHierarchicalNameAccess |
allows access to all descendants of this node | |
interface | com::sun::star::container::XContainer |
allows attaching listeners to this node to monitor changes to immediate child nodes. | |
interface | com::sun::star::beans::XExactName |
provides support for inexact names. | |
interface | com::sun::star::beans::XPropertySetInfo |
provides information about immediate children of this node. | |
interface | com::sun::star::beans::XPropertyState |
provides access to the state of child elements of an implementation. | |
interface | com::sun::star::beans::XMultiPropertyStates |
provides access to the states of multiple child elements of an implementation. | |
![]() | |
interface | com::sun::star::beans::XPropertySet |
provides access to and information about the immediate properties of an implementation. | |
interface | com::sun::star::beans::XMultiPropertySet |
provides access to and information about the immediate properties of an implementation. | |
interface | com::sun::star::beans::XHierarchicalPropertySet |
provides access to and information about the whole hierarchy of properties and subproperties of an implementation. | |
interface | com::sun::star::beans::XMultiHierarchicalPropertySet |
provides access to and information about the whole hierarchy of properties and subproperties of an implementation. | |
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 )
.
service 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.
service PropertyHierarchy |
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 com::sun::star::beans::PropertyAttribute::READONLY set, and attempts to change property values will fail.
|
optional |
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.
|
optional |
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.