LibreOffice
LibreOffice 7.2 SDK API Reference
Exported Interfaces | List of all members
HierarchyDataReadAccess Service Referencepublished

provides read access to a fragment of the hierarchy data. More...

import"HierarchyDataReadAccess.idl";

Inheritance diagram for HierarchyDataReadAccess:
XNameAccess XHierarchicalNameAccess XChangesNotifier XComponent XElementAccess XInterface XInterface XInterface XInterface HierarchyDataReadWriteAccess

Exported Interfaces

interface com::sun::star::container::XNameAccess
 gives access to the data members of a hierarchy data node. More...
 
interface com::sun::star::container::XHierarchicalNameAccess
 gives access to the data members of a hierarchy data node as well as to any child nodes or to the data members of child nodes using a hierarchical name. More...
 
interface com::sun::star::util::XChangesNotifier
 allows registering listeners that observe the hierarchy data source. More...
 
interface com::sun::star::lang::XComponent
 allows controlling or observing the lifetime of the hierarchy data access object. 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 XChangesNotifier
void addChangesListener ([in] com::sun::star::util::XChangesListener aListener)
 adds the specified listener to receive events when changes occurred. More...
 
void removeChangesListener ([in] com::sun::star::util::XChangesListener aListener)
 removes the specified listener. More...
 
- Public Member Functions inherited from XComponent
void dispose ()
 The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
 
void addEventListener ([in] XEventListener xListener)
 adds an event listener to the object. More...
 
void removeEventListener ([in] XEventListener aListener)
 removes an event listener from the listener list. More...
 

Detailed Description

provides read access to a fragment of the hierarchy data.

A hierarchy data source provides access to a tree of hierarchy data nodes. Each hierarchy data node, except the root node, has a parent that is a hierarchy data node too. A hierarchy data node has a name.

Each hierarchy data node has three data members:

Exported Interfaces

◆ com::sun::star::container::XHierarchicalNameAccess

gives access to the data members of a hierarchy data node as well as to any child nodes or to the data members of child nodes using a hierarchical name.

A hierarchical name consists of segments that are separated by a single slash ("/"). There is neither a leading nor a trailing slash allowed.

  • path = segment ( '/' segment )*
  • segment = '[' quoted-string ']'
  • quoted-string = "'" escaped-string "'"
  • escaped-string = escaped according to XML attribute naming conventions

Examples:

  • getByHierarchicalName( "Title" ) will return an any containing a string containing the title of the node itself.
  • getByHierarchicalName( "Children/['subnode1']" ) will give access to the child node named "subnode1" of the node. It will return an any containing an implementation of service HierarchyDataReadAccess, if it was called on a read-only node. It will return an implementation of service HierarchyDataReadWriteAccess if it was called on a writable node.
  • getByHierarchicalName( "Children/['subnode2']/TargetURL" ) will give direct access to the "TargetURL" data member of the child node named "subnode2" of the node. It will return an any containing a string containing the target URL of the node.
  • getByHierarchicalName( "Children/['subnode3']/Children" ) will give direct access to the "Children" data member of the child node named "subnode3" of the node. It will return an any containing an implementation of service HierarchyDataReadAccess, if it was called on a read-only node. It will return an implementation of service HierarchyDataReadWriteAccess if it was called on a writable node.

◆ com::sun::star::container::XNameAccess

gives access to the data members of a hierarchy data node.

Examples:

  • getByName( "Title" ) will return an any containing a string containing the title of the node.
  • getByName( "Children" ) will return an any containing an implementation of service HierarchyDataReadAccess, if it was called on a read-only node. It will return an implementation of service HierarchyDataReadWriteAccess if it was called on a writable node.

◆ com::sun::star::lang::XComponent

allows controlling or observing the lifetime of the hierarchy data access object.

◆ com::sun::star::util::XChangesNotifier

allows registering listeners that observe the hierarchy data source.

A client can register an com::sun::star::util::XChangesListener, which will receive notifications for any changes within the hierarchy (fragment) this object represents.

An implementation should collect as many changes as possible into a single com::sun::star::util::ChangesEvent.


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