receives a description of a configuration update or layer as a sequence of events.
More...
|
void | startUpdate () raises ( MalformedDataException, com::sun::star::lang::IllegalAccessException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that an update or description is started.
|
void | endUpdate () raises ( MalformedDataException, com::sun::star::lang::IllegalAccessException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that the current update description is complete.
|
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.
|
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.
|
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.
|
void | endNode () raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that a node modification is complete.
|
void | removeNode ([in] string aName) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that an item is to be dropped from a set.
|
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.
|
void | setPropertyValue ([in] any aValue) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification about a change to the value of the current property.
|
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.
|
void | resetPropertyValue () raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that the value of the current property should be reset to its default.
|
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.
|
void | endProperty () raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that a property modification is complete.
|
void | resetProperty ([in] string aName) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that a property is reset to its default state.
|
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.
|
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.
|
void | removeProperty ([in] string aName) raises ( MalformedDataException, com::sun::star::lang::WrappedTargetException ) |
| receives notification that a property is dropped from the current node.
|
any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object.
|
void | acquire () |
| increases the reference counter by one.
|
void | release () |
| decreases the reference counter by one.
|
receives a description of a configuration update or layer as a sequence of events.
- Since
- OOo 1.1.2
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
-
aName | specifies the name of the new item. |
aAttributes | specifies 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
-
- See also
- com::sun::star::configuration::backend::NodeAttribute
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
-
aName | specifies the name of the new property. |
aAttributes | specifies 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
-
aType | specifies 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
-
- See also
- com::sun::star::configuration::backend::SchemaAttribute
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
-
aName | specifies the name of the new property. |
aAttributes | specifies 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
-
aValue | specifies 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
-
- See also
- com::sun::star::configuration::backend::SchemaAttribute
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
-
aName | specifies the name of the node. |
aAttributes | specifies 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
-
aAttributeMask | specifies which attributes should be changed for the node. |
The value is a combination of NodeAttribute flags.
- Parameters
-
bReset | if 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
-
- See also
- com::sun::star::configuration::backend::NodeAttribute
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
-
aName | specifies the name of the property. |
aAttributes | specifies 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
-
aAttributeMask | specifies which attributes should be changed for the property. |
The value is a combination of NodeAttribute flags.
- Parameters
-
aType | specifies 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
-
- See also
- com::sun::star::configuration::backend::NodeAttribute