LibreOffice LibreOffice 25.8 SDK API Reference

Exported Interfaces | List of all members
LayerUpdateMerger Service Referencepublished

applies updates to a configuration layer. More...

`import"LayerUpdateMerger.idl";`

Inheritance diagram for LayerUpdateMerger:

## Exported Interfaces
interface | com::sun::star::configuration::backend::XUpdateHandler
| accepts events describing the changes. More...
interface | com::sun::star::lang::XInitialization
| allows initializing layer data source and target. More...

## Additional Inherited Members
Public Member Functions inherited from XUpdateHandler
void | startUpdate () raises ( MalformedDataException, com::sun::star::lang::IllegalAccessException, com::sun::star::lang::WrappedTargetException )
| receives notification that an update or description is started. More...
void | endUpdate () raises ( MalformedDataException, com::sun::star::lang::IllegalAccessException, com::sun::star::lang::WrappedTargetException )
| receives notification that the current update description is complete. More...
void | modifyNode ([in] string aName, [in] short aAttributes, [in] short aAttributeMask, [in] boolean bReset) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException )
| receives notification that a modification of a node is started. More...
void | addOrReplaceNode ([in] string aName, [in] short aAttributes) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException )
| receives notification that a node is started as a new item. More...
void | addOrReplaceNodeFromTemplate ([in] string aName, [in] short aAttributes, [in] TemplateIdentifier aTemplate) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException )
| receives notification that a node is started as a new item based on a particular template. More...
void | endNode () raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException )
| receives notification that a node modification is complete. More...
void | removeNode ([in] string aName) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException )
| receives notification that an item is to be dropped from a set. More...
void | modifyProperty ([in] string aName, [in] short aAttributes, [in] short aAttributeMask, [in] type aType) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException )
| receives notification that modification of an existing property is started. More...
void | setPropertyValue ([in] any aValue) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException )
| receives notification about a change to the value of the current property. More...
void | setPropertyValueForLocale ([in] any aValue, [in] string aLocale) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException )
| receives notification about a change to the value of the current property for a specific locale. More...
void | resetPropertyValue () raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException )
| receives notification that the value of the current property should be reset to its default. More...
void | resetPropertyValueForLocale ([in] string aLocale) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException )
| receives notification that the value of the current property for a specific locale should be reset to its default. More...
void | endProperty () raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException )
| receives notification that a property modification is complete. More...
void | resetProperty ([in] string aName) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException )
| receives notification that a property is reset to its default state. More...
void | addOrReplaceProperty ([in] string aName, [in] short aAttributes, [in] type aType) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException )
| receives notification that a property having a value of `VOID` is added to the current node. More...
void | addOrReplacePropertyWithValue ([in] string aName, [in] short aAttributes, [in] any aValue) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException )
| receives notification that a property having a non-`NULL` value is added to the current node. More...
void | removeProperty ([in] string aName) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException )
| receives notification that a property is dropped from the current node. 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 XInitialization
void | initialize ([in] sequence< any > aArguments) raises ( com::sun::star::uno::Exception )
| initializes the object. More...

## Detailed Description

applies updates to a configuration layer.

The configuration layer data is read from a XLayer and the changed layer is provided as XLayer again or described to a XLayerHandler.

See also
  com::sun::star::configuration::backend::UpdatableLayer Service describes a layer and accepts a changed layer...

Since
  OOo 1.1.2

## Exported Interfaces

## ◆ com::sun::star::configuration::backend::XUpdateHandler

interface com::sun::star::configuration::backend::XUpdateHandler

accepts events describing the changes.

## ◆ com::sun::star::lang::XInitialization

interface com::sun::star::lang::XInitialization

allows initializing layer data source and target.

Both source and target of the update can be provided by passing a XUpdatableLayer object. Alternatively they can be provided individually by providing a XLayer object as data source and an XLayerHandler object to receive the updated data.

Implementations can provide more arguments to fine tune the behavior. Such arguments are provided as com::sun::star::beans::NamedValue. Implementations should support the following named arguments:

`Overwrite` : `boolean`
  If `FALSE`, specifies that changes should be applied only if the existing layer is empty.
`Truncate` : `boolean`
  If `TRUE` requests that changes should not be merged onto existing data, but that the changes should be applied to a layer that is completely empty.

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

- com/sun/star/configuration/backend/LayerUpdateMerger.idl