LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XUpdateHandler Interface Referencepublished

receives a description of a configuration update or layer as a sequence of events. More...

import"XUpdateHandler.idl";

Inheritance diagram for XUpdateHandler:
XInterface LayerUpdateMerger

Public Member Functions

void startUpdate () raises ( MalformedDataException, com::sun::star::lang::IllegalAccessException, com::sun::star::lang::WrappedTargetException )
 receives notification that a 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...
 

Detailed Description

receives a description of a configuration update or layer as a sequence of events.

Since
OOo 1.1.2

Member Function Documentation

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.

The current node must be a set and a preexisting item (if any) must be removable.

The new item will be created from the default template of the set.

Subsequent calls describe the difference from the template of properties, items or members of the node until a matching call to XUpdateHandler::endNode() is encountered.

Parameters
aNamespecifies the name of the new item.
aAttributesspecifies attribute values to be applied to the new node.

The value is a combination of NodeAttribute flags. Note that NodeAttribute::FUSE has an impact on the semantics of this method.

Exceptions
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't a set node in progress currently
  • if there already was a change to an item of that name
  • if the template for the new node is not found
  • if an item of that name exists and is not removable
  • if the name is not a valid item name
  • if the attributes are not valid for the node

Not every implementation can detect each condition

Exceptions
com::sun::star::lang::WrappedTargetExceptionif an error occurs processing the event.
See also
com::sun::star::configuration::backend::NodeAttribute
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.

The current node must be a set and a preexisting item (if any) must be removable.

Subsequent calls describe the difference from the template of properties or members of the node until a matching call to XUpdateHandler::endNode() is encountered.

Parameters
aNamespecifies the name of the item.
aTemplatespecifies the template to use for the new node
aAttributesspecifies attribute values to be applied to the new node.

The value is a combination of NodeAttribute flags. Note that NodeAttribute::FUSE has an impact on the semantics of this method.

Exceptions
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't a set node in progress currently
  • if there already was a change to an item of that name
  • if the template for the new node is not found
  • if an item of that name exists and is not removable
  • if the name is not a valid item name
  • if the template is not a valid item type for the containing set
  • if the attributes are not valid for the node

Not every implementation can detect each condition

Exceptions
com::sun::star::lang::WrappedTargetExceptionif an error occurs processing the event.
See also
com::sun::star::configuration::backend::NodeAttribute
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.

The current node must be extensible and a preexisting property (if any) must be removable in this layer.

Parameters
aNamespecifies the name of the new property.
aAttributesspecifies the attributes of the new property.

The value is a combination of NodeAttribute flags and may also contain the SchemaAttribute::REQUIRED flag.

NodeAttribute::MANDATORY need not be set, as dynamic properties always are mandatory in subsequent layers.

Parameters
aTypespecifies the type of the new property.
Exceptions
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't a group or extensible node in progress currently
  • if there already was a change to a property of that name
  • if a property of that name exists and is not removable
  • if the specified type is not allowed
  • if the name is not a valid property name
  • if the attributes are not valid for the property

Not every implementation can detect each condition

Exceptions
com::sun::star::lang::WrappedTargetExceptionif an error occurs processing the event.
See also
com::sun::star::configuration::backend::SchemaAttribute
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.

The current node must be extensible and a preexisting property (if any) must be removable in this layer.

Parameters
aNamespecifies the name of the new property.
aAttributesspecifies the attributes of the new property.

The value is a combination of NodeAttribute flags and may also contain the SchemaAttribute::REQUIRED flag.

NodeAttribute::MANDATORY need not be set, as dynamic properties always are mandatory in subsequent layers.

Parameters
aValuespecifies the value of the new property.

The value also determines the type. Therefore the value must not be VOID.

Exceptions
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't a group or extensible node in progress currently
  • if there already was a change to a property of that name
  • if a property of that name exists and is not removable
  • if the type of the value is not an allowed type, or if the value is VOID
  • if the name is not a valid property name
  • if the attributes are not valid for the property

Not every implementation can detect each condition

Exceptions
com::sun::star::lang::WrappedTargetExceptionif an error occurs processing the event.
See also
com::sun::star::configuration::backend::SchemaAttribute

receives notification that a node modification is complete.

Must match the last open call to XUpdateHandler::modifyNode(), XUpdateHandler::addOrReplaceNode() or XUpdateHandler::addOrReplaceNodeFromTemplate().

Exceptions
com::sun::star::configuration::backend::MalformedDataException
  • if invalid data is detected in the node
  • if no node is started at all

Not every implementation can detect each condition

Exceptions
com::sun::star::lang::WrappedTargetExceptionif an error occurs processing the event.

receives notification that a property modification is complete.

Must match the last open call to XUpdateHandler::modifyProperty().

Exceptions
com::sun::star::configuration::backend::MalformedDataException
  • if invalid data is detected in the property
  • if no property is started at all

Not every implementation can detect each condition

Exceptions
com::sun::star::lang::WrappedTargetExceptionif an error occurs processing the event.

receives notification that the current update description is complete.

Must match a previous call to XUpdateHandler::startUpdate().

Exceptions
com::sun::star::configuration::backend::MalformedDataException
  • if no update is started at all
  • if invalid data is detected in the update
  • if there is an unfinished subnode in progress
  • if the update tries to change read-only data

Not every implementation can detect each condition

Exceptions
com::sun::star::lang::IllegalAccessExceptionif the target layer is read-only
com::sun::star::lang::WrappedTargetExceptionif an error occurs processing the event.
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.

Subsequent calls describe changes to properties and items or members of the node until a matching call to XUpdateHandler::endNode() is encountered.

Parameters
aNamespecifies the name of the node.
aAttributesspecifies attribute values to be applied to the node in the current layer.

The value is a combination of NodeAttribute flags.

Only attributes which are selected in aAttributeMask are changed.

Parameters
aAttributeMaskspecifies which attributes should be changed for the node.

The value is a combination of NodeAttribute flags.

Parameters
bResetif TRUE, specifies that the node should be reset to its default state as given by lower layers and the schema or template prior to applying the changes.
Exceptions
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't an update in progress at all
  • if a node is not valid in this place
  • if there already was a change to that node
  • if there is no node with that name
  • if the node is read-only
  • if the name is not a valid node name
  • if the attributes or mask are not valid for the node

Not every implementation can detect each condition

Exceptions
com::sun::star::lang::WrappedTargetExceptionif an error occurs processing the event.
See also
com::sun::star::configuration::backend::NodeAttribute
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.

Subsequent calls describe changes to the value(s) of the property until a matching call to XUpdateHandler::endProperty() is encountered.

Parameters
aNamespecifies the name of the property.
aAttributesspecifies new attributes of the property.

The value is a combination of NodeAttribute flags.

Only attributes which are selected in aAttributeMask are changed.

NodeAttribute::MANDATORY need not be set and can't be removed, as dynamic properties always are mandatory in subsequent layers.

Parameters
aAttributeMaskspecifies which attributes should be changed for the property.

The value is a combination of NodeAttribute flags.

Parameters
aTypespecifies the type of the property.

A VOID type can be used to signify that the type is unknown and should not be recorded.

Exceptions
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't a group or extensible node in progress currently
  • if there already was a change to a property of that name
  • if there is no property with that name
  • if the property is read-only
  • if the name is not a valid property name
  • if the attributes are not valid for the property

Not every implementation can detect each condition

Exceptions
com::sun::star::lang::WrappedTargetExceptionif an error occurs processing the event.
See also
com::sun::star::configuration::backend::NodeAttribute
void removeNode ( [in] string  aName)
raises ( MalformedDataException,
com::sun::star::lang::WrappedTargetException
)

receives notification that an item is to be dropped from a set.

The current node must be a set and the item must be removable.

Parameters
aNamespecifies the name of the node.
Exceptions
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't a set node in progress currently
  • if there already was a change to a node of that name
  • if there is no item with that name
  • if the item is not removable
  • if the name is not a valid node name

Not every implementation can detect each condition

Exceptions
com::sun::star::lang::WrappedTargetExceptionif an error occurs processing the event.
void removeProperty ( [in] string  aName)
raises ( MalformedDataException,
com::sun::star::lang::WrappedTargetException
)

receives notification that a property is dropped from the current node.

The current node must be extensible and the property removable.

Parameters
aNamespecifies the name of the property.
Exceptions
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't a group or extensible node in progress currently
  • if there is no property with that name
  • if the property is not removable
  • if the name is not a valid node name

Not every implementation can detect each condition

Exceptions
com::sun::star::lang::WrappedTargetExceptionif an error occurs processing the event.
void resetProperty ( [in] string  aName)
raises ( MalformedDataException,
com::sun::star::lang::WrappedTargetException
)

receives notification that a property is reset to its default state.

Parameters
aNamespecifies the name of the property.
Exceptions
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't a group or extensible node in progress currently
  • if there already was a change to a property of that name
  • if there is no property with that name, or if the property has no default
  • if the property is read-only
  • if the name is not a valid property name

Not every implementation can detect each condition

Exceptions
com::sun::star::lang::WrappedTargetExceptionif an error occurs processing the event.
See also
com::sun::star::configuration::backend::NodeAttribute

receives notification that the value of the current property should be reset to its default.

Exceptions
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't a property modification in progress currently
  • if there already was a change to this value

Not every implementation can detect each condition

Exceptions
com::sun::star::lang::WrappedTargetExceptionif an error occurs processing the event.
See also
com::sun::star::configuration::backend::NodeAttribute
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.

Parameters
aLocalespecifies the locale the change applies to.
Exceptions
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't a property modification in progress currently
  • if the property is not localizable
  • if there already was a change to this value
  • if the locale is not a valid locale name

Not every implementation can detect each condition

Exceptions
com::sun::star::lang::WrappedTargetExceptionif an error occurs processing the event.
See also
com::sun::star::configuration::backend::NodeAttribute
void setPropertyValue ( [in] any  aValue)
raises ( MalformedDataException,
com::sun::star::lang::WrappedTargetException
)

receives notification about a change to the value of the current property.

Parameters
aValuespecifies the new value of the property.

The value must match the type of the existing property. If the property does not have the SchemaAttribute::REQUIRED flag set, the value can be VOID.

Exceptions
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't a property modification in progress currently
  • if there already was a change to this value
  • if the type of the value is not an allowed type
  • if the value is not valid for the property

Not every implementation can detect each condition

Exceptions
com::sun::star::lang::WrappedTargetExceptionif an error occurs processing the event.
See also
com::sun::star::configuration::backend::NodeAttribute
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.

Parameters
aValuespecifies the new value of the property for the given locale.

The value must match the type of the existing property. If the property does not have the SchemaAttribute::REQUIRED flag set, the value can be VOID.

Parameters
aLocalespecifies the locale that the new value applies to.
Exceptions
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't a property modification in progress currently
  • if the property is not localizable
  • if there already was a change to this value
  • if the type of the value is not an allowed type
  • if the value is not valid for the property
  • if the locale is not a valid locale name

Not every implementation can detect each condition

Exceptions
com::sun::star::lang::WrappedTargetExceptionif an error occurs processing the event.
See also
com::sun::star::configuration::backend::NodeAttribute

receives notification that a update or description is started.

Exceptions
com::sun::star::configuration::backend::MalformedDataExceptionif the update already was started
com::sun::star::lang::IllegalAccessExceptionif the target layer is read-only

Some implementations can only detect this when executing XUpdateHandler::endUpdate()

Exceptions
com::sun::star::lang::WrappedTargetExceptionif an error occurs processing the event.

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