LibreOffice
LibreOffice 6.2 SDK API Reference
Exported Interfaces | List of all members
HierarchyAccess Service Referencepublished

provides access to a hierarchy of descendant elements. More...

import"HierarchyAccess.idl";

Inheritance diagram for HierarchyAccess:
XNameAccess XHierarchicalNameAccess XContainer XExactName XPropertySetInfo XPropertyState XMultiPropertyStates XElementAccess XInterface XInterface XInterface XInterface XInterface XInterface XInterface ConfigurationAccess GroupAccess SetAccess ConfigurationUpdateAccess ConfigurationAccess GroupUpdate ConfigurationAccess SetUpdate ConfigurationUpdateAccess ConfigurationUpdateAccess ConfigurationUpdateAccess ConfigurationUpdateAccess

Exported Interfaces

interface com::sun::star::container::XNameAccess
 allows access to immediate children of this node. More...
 
interface com::sun::star::container::XHierarchicalNameAccess
 allows access to all descendants of this node More...
 
interface com::sun::star::container::XContainer
 allows attaching listeners to this node to monitor changes to immediate child nodes. More...
 
interface com::sun::star::beans::XExactName
 provides support for inexact names. More...
 
interface com::sun::star::beans::XPropertySetInfo
 provides information about immediate children of this node. More...
 
interface com::sun::star::beans::XPropertyState
 provides access to the state of child elements of an implementation. More...
 
interface com::sun::star::beans::XMultiPropertyStates
 provides access to the states of multiple child elements of an implementation. More...
 

Additional Inherited Members

- Public Member Functions inherited from XNameAccess
any getByName ([in] string aName) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
 
sequence< string > getElementNames ()
 
boolean hasByName ([in] string aName)
 
- Public Member Functions inherited from XElementAccess
type getElementType ()
 
boolean hasElements ()
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Public Member Functions inherited from XHierarchicalNameAccess
any getByHierarchicalName ([in] string aName) raises ( com::sun::star::container::NoSuchElementException )
 
boolean hasByHierarchicalName ([in] string aName)
 
- Public Member Functions inherited from XContainer
void addContainerListener ([in] com::sun::star::container::XContainerListener xListener)
 adds the specified listener to receive events when elements are inserted or removed. More...
 
void removeContainerListener ([in] com::sun::star::container::XContainerListener xListener)
 removes the specified listener so it does not receive any events from this container. More...
 
- Public Member Functions inherited from XExactName
string getExactName ([in] string aApproximateName)
 
- Protected Member Functions inherited from XPropertySetInfo
sequence< com::sun::star::beans::PropertygetProperties ()
 
com::sun::star::beans::Property getPropertyByName ([in] string aName) raises ( com::sun::star::beans::UnknownPropertyException )
 
boolean hasPropertyByName ([in] string Name)
 
- Protected Member Functions inherited from XPropertyState
com::sun::star::beans::PropertyState getPropertyState ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 
sequence< com::sun::star::beans::PropertyStategetPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 
void setPropertyToDefault ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 Sets the property to default value. More...
 
any getPropertyDefault ([in] string aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
- Protected Member Functions inherited from XMultiPropertyStates
sequence< com::sun::star::beans::PropertyStategetPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 
void setAllPropertiesToDefault ()
 sets all properties to their default values. More...
 
void setPropertiesToDefault ([in] sequence< string > aPropertyNames) raises ( com::sun::star::beans::UnknownPropertyException )
 sets the specified properties to their default values. More...
 
sequence< any > getPropertyDefaults ([in] sequence< string > aPropertyNames) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 

Detailed Description

provides access to a hierarchy of descendant elements.

Subnodes are accessed by their name. Values that are direct or indirect descendants of this tree node can be retrieved. Non-value subnodes can be navigated using container interfaces. Other interfaces provide access to information about this node. Changes to values in the subtree can be monitored by event listeners.

Elements of this container that are not simple values are similar containers themselves, thus (recursively) forming a hierarchical tree.

Implementations of this service usually also implement service HierarchyElement, which concerns the complementary role of being accessible as an element of the hierarchy.

Exported Interfaces

provides support for inexact names.

Exact names can be obtained for simple or hierarchical names for use in com::sun::star::container::XNameAccess, com::sun::star::container::XHierarchicalNameAccess, com::sun::star::beans::XPropertySet or any other interfaces that allow access to or manipulation of subnodes selected by name or hierarchical name.

If an inexact name could be matched to either a simple or a hierarchical name, the simple (immediate child) name is preferred.

provides access to the states of multiple child elements of an implementation.

[optional]

This interface may be missing if the hierarchy (or a hierarchy fragment that contains this implementation as element) does not support default values if the node does not support accessing the default state of individual children.

If elements that are not simple values, but objects themselves, support a default state (as indicated by com::sun::star::beans::PropertyAttribute::MAYBEDEFAULT), they should implement com::sun::star::beans::XPropertyWithState, in which case the com::sun::star::beans::PropertyState applies to all their children and recursively to all descendants.

If an implementation is part of a read-only view of the hierarchy, attempts to change property states will fail.

provides information about immediate children of this node.

[optional]

This interface may be missing, if the hierarchy supports no traits that are described by com::sun::star::beans::PropertyAttribute values or if the same information is available by other means, e.g. if the implementation supports com::sun::star::beans::XPropertySet::getPropertySetInfo().

If a child of this node is an object that implements com::sun::star::beans::XProperty, then this implementation returns the same com::sun::star::beans::Property for that child as the child itself.

provides access to the state of child elements of an implementation.

[optional]

This interface may be missing if the hierarchy (or a hierarchy fragment that contains this implementation as element) does not support default values or if the node does not support accessing the default state of individual children.

If elements that are not simple values, but objects themselves, support a default state (as indicated by com::sun::star::beans::PropertyAttribute::MAYBEDEFAULT), they should implement com::sun::star::beans::XPropertyWithState, in which case the com::sun::star::beans::PropertyState applies to all their children and recursively to all descendants.

If an implementation is part of a read-only view of the hierarchy, attempts to change property states will fail.

allows attaching listeners to this node to monitor changes to immediate child nodes.

allows access to all descendants of this node

com::sun::star::container::XHierarchicalNameAccess::getByHierarchicalName() returns an any holding either a simple value or an interface on another HierarchyAccess if the descendant is not a simple value.

allows access to immediate children of this node.

com::sun::star::container::XNameAccess::getByName() returns an any holding either a simple value or an interface on another HierarchyAccess if the child is not a simple value.


The documentation for this service was generated from the following file: