LibreOffice
LibreOffice 6.2 SDK API Reference
Included Services | Exported Interfaces | List of all members
AccessRootElement Service Referencepublished

provides information about the root element of a hierarchy and about the hierarchy as a whole. More...

import"AccessRootElement.idl";

Inheritance diagram for AccessRootElement:
HierarchyElement XComponent XChangesNotifier XLocalizable XInterface XInterface XInterface XChild XPropertyWithState XProperty XNamed XHierarchicalName ConfigurationAccess UpdateRootElement ConfigurationUpdateAccess ConfigurationUpdateAccess

Included Services

service HierarchyElement
 the basic service for accessing information about an element in the hierarchy. More...
 

Exported Interfaces

interface com::sun::star::lang::XComponent
 allows controlling or observing the lifetime of the whole hierarchy. More...
 
interface com::sun::star::util::XChangesNotifier
 allows registering listeners that observe the whole hierarchy. More...
 
interface com::sun::star::lang::XLocalizable
 provides access to the locale that applies to locale-dependent data in this hierarchy. More...
 
- Exported Interfaces inherited from HierarchyElement
interface com::sun::star::container::XHierarchicalName
 provides the complete hierarchical name of this element within the hierarchy tree. More...
 
interface com::sun::star::container::XNamed
 provides the local name of this element within its parent. More...
 
interface com::sun::star::beans::XProperty
 provides a property descriptor for this element. More...
 
interface com::sun::star::beans::XPropertyWithState
 provides access to the default state of this element. More...
 
interface com::sun::star::container::XChild
 provides access to the parent of this element [optional]. More...
 

Additional Inherited Members

- Public Member Functions inherited from XHierarchicalName
string getHierarchicalName ()
 
string composeHierarchicalName ([in] string aRelativeName) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::NoSupportException )
 builds the hierarchical name of an object, given a relative name More...
 
- 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 XNamed
string getName ()
 
void setName ([in] string aName)
 sets the programmatic name of the object. 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...
 
- 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...
 
- Protected Member Functions inherited from XProperty
com::sun::star::beans::Property getAsProperty ()
 
- Protected Member Functions inherited from XPropertyWithState
com::sun::star::beans::PropertyState getStateAsProperty ()
 
void setToDefaultAsProperty () raises ( com::sun::star::lang::WrappedTargetException )
 sets this to its default value. More...
 
com::sun::star::uno::XInterface getDefaultAsProperty () raises ( com::sun::star::lang::WrappedTargetException )
 
- Protected Member Functions inherited from XChild
com::sun::star::uno::XInterface getParent ()
 grants access to the object containing this content. More...
 
void setParent ([in] com::sun::star::uno::XInterface Parent) raises ( com::sun::star::lang::NoSupportException )
 sets the parent to this object. More...
 
- Protected Member Functions inherited from XLocalizable
void setLocale ([in] Locale eLocale)
 sets the locale to be used by this object. More...
 
Locale getLocale ()
 

Detailed Description

provides information about the root element of a hierarchy and about the hierarchy as a whole.

Provides information about the element and the whole hierarchy. Allows controlling the lifetime of the hierarchy. Allows observing changes in the hierarchy as a whole.

When access to a hierarchy is first obtained from a factory or provider, this is the initial object that is created by the factory. It represents the root of the accessible part of the hierarchy.

NOTE: In this description "hierarchy" may actually designate a part or fragment of a larger hierarchy. It is that part that is rooted in the element represented by an implementation of this service and that is accessible starting from this element.

Generally it is not possible to navigate the parent or siblings, if any, of this element, so com::sun::star::container::XChild is not supported.

See also
com::sun::star::configuration::UpdateRootElement Implementations that support modifying data in the hierarchy implement service UpdateRootElement.
com::sun::star::configuration::SetElement A complementary service, for children of a dynamic homogeneous container.
com::sun::star::configuration::GroupElement A complementary service, for children of a static heterogeneous collection.
com::sun::star::configuration::ConfigurationProvider Objects provided by a ConfigurationProvider implement this service.

Exported Interfaces

the basic service for accessing information about an element in the hierarchy.

Exported Interfaces

allows controlling or observing the lifetime of the whole hierarchy.

The owner of the hierarchy may dispose of this object using com::sun::star::lang::XComponent::dispose(). As this object owns its child elements and, recursively, the whole hierarchy, any descendant elements obtained, directly or indirectly, from this object will also be disposed. Disposing of the object does not affect a persistent representation of the hierarchy.

When an implementation is obtained from a factory or provider, ownership of it is usually transferred to the client. See the documentation of the particular provider or factory service for details.

The provider of this object may still dispose of this object, when the lifetime of the provider ends or if these objects represent the root of only a fragment of an enclosing hierarchy and this fragment is removed from the complete hierarchy by an outside source.

Clients may register an com::sun::star::lang::XEventListener to be notified when the object is disposed for either cause.

provides access to the locale that applies to locale-dependent data in this hierarchy.

[optional]

This interface may be missing if the implementation does not support locale-dependent data in the hierarchy or if the (partial) hierarchy rooted in this object does not contain any locale-dependent elements.

Changing the locale is generally not supported. If it is supported, there is no guarantee that values already loaded into the hierarchy, or an application cache, are refreshed to reflect the new locale. Use of com::sun::star::lang::XLocalizable::setLocale() is therefore not recommended.

allows registering listeners that observe the whole hierarchy.

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 will collect as many changes as possible into a single com::sun::star::util::ChangesEvent. For Example:

If com::sun::star::beans::XMultiPropertySet::setPropertyValues() or com::sun::star::beans::XMultiHierarchicalPropertySet::setHierarchicalPropertyValues() is used on an element of the hierarchy to change multiple values within the hierarchy, all changes will be notified with a single event.

If an outside source uses com::sun::star::util::XChangesBatch::commitChanges() on an overlapping hierarchy access, all relevant changes will be notified with a single event.

See also
UpdateRootElement
com::sun::star::util::XChangesBatch

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