:: com :: sun :: star :: configuration ::
|
service HierarchyElement |
- Description
- provides information about an element within a hierarchy.
The local name and the full hierarchical name can be retrieved.
Attributes detailing the role of the element can be queried.
The state of the element (regarding defaults) can be accessed.
Implementations of this service usually also implement
service HierarchyAccess, which concerns the complementary role
of providing access to subelements of the hierarchy.
|
Exported Interfaces - Details |
::com::sun::star::container::XHierarchicalName
- Description
- provides the complete hierarchical name of this element
within the hierarchy tree.
|
|
::com::sun::star::container::XNamed
- Description
- provides the local name of this element within its parent.
Renaming an element is generally not supported.
|
|
::com::sun::star::beans::XProperty
- Usage Restrictions
- optional
- Description
- provides a property descriptor for this element.[optional]
This interface may be missing, if the hierarchy supports no traits that are
described by ::com::sun::star::beans::PropertyAttribute
values.
If the parent of this object implements
::com::sun::star::beans::XPropertySetInfo, then this returns
the same ::com::sun::star::beans::Property as the
::com::sun::star::beans::XPropertySetInfo of the parent.
|
|
::com::sun::star::beans::XPropertyWithState
- Usage Restrictions
- optional
- Description
- provides access to the default state of this element. [optional]
This interface may be missing, if the hierarchy supports access to
a default state and values only for simple values or not at all.
If the parent of this object implements
::com::sun::star::beans::XPropertyState, then members
of this interface have the same effect as corresponding members of the parent.
If an implementation is part of a read-only view of the hierarchy,
attempts to change property states will fail.
|
|
::com::sun::star::container::XChild
- Usage Restrictions
- optional
- Description
- provides access to the parent of this element [optional].
This interface may be missing if this object is not obtained
as a child or descendant of another tree node, for example, directly from a factory or provider.
::com::sun::star::container::XChild::getParent()
returns NULL, if this object is currently not contained in another node.
Setting a different parent is, generally, not supported.
|
|
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.