<html> <head> <title>Interface XUpdateHandler</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XUpdateHandler-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../../module-ix.html" class="namechain">::</a> <a href="../../../../module-ix.html" class="namechain">com</a> :: <a href="../../../module-ix.html" class="namechain">sun</a> :: <a href="../../module-ix.html" class="namechain">star</a> :: <a href="../module-ix.html" class="namechain">configuration</a> :: <a href="module-ix.html" class="namechain">backend</a> :: </p> </td> </tr> <tr> <td class="title">interface XUpdateHandler</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>receives a description of a configuration update or layer as a sequence of events. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#startUpdate">startUpdate</a></td> <td class="imsum_right">receives notification that a update or description is started. </td> </tr> <tr> <td class="imsum_left"><a href="#endUpdate">endUpdate</a></td> <td class="imsum_right">receives notification that the current update description is complete. </td> </tr> <tr> <td class="imsum_left"><a href="#modifyNode">modifyNode</a></td> <td class="imsum_right">receives notification that a modification of a node is started. </td> </tr> <tr> <td class="imsum_left"><a href="#addOrReplaceNode">addOrReplaceNode</a></td> <td class="imsum_right">receives notification that a node is started as a new item. </td> </tr> <tr> <td class="imsum_left"><a href="#addOrReplaceNodeFromTemplate">addOrReplaceNodeFromTemplate</a></td> <td class="imsum_right">receives notification that a node is started as a new item based on a particular template. </td> </tr> <tr> <td class="imsum_left"><a href="#endNode">endNode</a></td> <td class="imsum_right">receives notification that a node modification is complete. </td> </tr> <tr> <td class="imsum_left"><a href="#removeNode">removeNode</a></td> <td class="imsum_right">receives notification that an item is to be dropped from a set. </td> </tr> <tr> <td class="imsum_left"><a href="#modifyProperty">modifyProperty</a></td> <td class="imsum_right">receives notification that modification of an existing property is started. . </td> </tr> <tr> <td class="imsum_left"><a href="#setPropertyValue">setPropertyValue</a></td> <td class="imsum_right">receives notification about a change to the value of the current property. </td> </tr> <tr> <td class="imsum_left"><a href="#setPropertyValueForLocale">setPropertyValueForLocale</a></td> <td class="imsum_right">receives notification about a change to the value of the current property for a specific locale. </td> </tr> <tr> <td class="imsum_left"><a href="#resetPropertyValue">resetPropertyValue</a></td> <td class="imsum_right">receives notification that the value of the current property should be reset to its default. </td> </tr> <tr> <td class="imsum_left"><a href="#resetPropertyValueForLocale">resetPropertyValueForLocale</a></td> <td class="imsum_right">receives notification that the value of the current property for a specific locale should be reset to its default. </td> </tr> <tr> <td class="imsum_left"><a href="#endProperty">endProperty</a></td> <td class="imsum_right">receives notification that a property modification is complete. </td> </tr> <tr> <td class="imsum_left"><a href="#resetProperty">resetProperty</a></td> <td class="imsum_right">receives notification that a property is reset to its default state. </td> </tr> <tr> <td class="imsum_left"><a href="#addOrReplaceProperty">addOrReplaceProperty</a></td> <td class="imsum_right">receives notification that a property having a value of <b>void</b> is added to the current node. </td> </tr> <tr> <td class="imsum_left"><a href="#addOrReplacePropertyWithValue">addOrReplacePropertyWithValue</a></td> <td class="imsum_right">receives notification that a property having a non-<b>NULL</b> value is added to the current node. </td> </tr> <tr> <td class="imsum_left"><a href="#removeProperty">removeProperty</a></td> <td class="imsum_right">receives notification that a property is dropped from the current node. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="startUpdate" class="membertitle">startUpdate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>startUpdate</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalAccessException.html">IllegalAccessException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>receives notification that a update or description is started. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException if the update already was started </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalAccessException if the target layer is read-only <p><em>Some implementations can only detect this when executing <a href="XUpdateHandler.html">XUpdateHandler</a>::<a href="XUpdateHandler.html#endUpdate">endUpdate()</a></em> </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs processing the event. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="endUpdate" class="membertitle">endUpdate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>endUpdate</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalAccessException.html">IllegalAccessException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>receives notification that the current update description is complete. </dd> <dd><p> Must match a previous call to <a href="XUpdateHandler.html">XUpdateHandler</a>::<a href="XUpdateHandler.html#startUpdate">startUpdate()</a>. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if no update is started at all</li> <li>if invalid data is detected in the update</li> <li>if there is an unfinished subnode in progress</li> <li>if the update tries to change read-only data</li> </ul> <p><em>Not every implementation can detect each condition</em></p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalAccessException if the target layer is read-only </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs processing the event. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="modifyNode" class="membertitle">modifyNode</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>modifyNode</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName,</td> </tr> <tr> <td/><td valign="top">[in] short</td> <td valign="bottom"> aAttributes,</td> </tr> <tr> <td/><td valign="top">[in] short</td> <td valign="bottom"> aAttributeMask,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bReset )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>receives notification that a modification of a node is started. </dd> <dd><p> Subsequent calls describe changes to properties and items or members of the node until a matching call to <a href="XUpdateHandler.html">XUpdateHandler</a>::<a href="XUpdateHandler.html#endNode">endNode()</a> is encountered. </p> </dd> <dt><b>Parameter aName</b></dt> <dd>specifies the name of the node. </dd> <dt><b>Parameter aAttributes</b></dt> <dd>specifies attribute values to be applied to the node in the current layer. <p> The value is a combination of <a href="NodeAttribute.html">NodeAttribute</a> flags. </p> <p> Only attributes which are selected in aAttributeMask are changed. </p> </dd> <dt><b>Parameter aAttributeMask</b></dt> <dd>specifies which attributes should be changed for the node. <p> The value is a combination of <a href="NodeAttribute.html">NodeAttribute</a> flags. </p> </dd> <dt><b>Parameter bReset</b></dt> <dd>if <b>true</b>, 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. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there isn't an update in progress at all</li> <li>if a node is not valid in this place</li> <li>if there already was a change to that node</li> <li>if there is no node with that name</li> <li>if the node is read-only</li> <li>if the name is not a valid node name</li> <li>if the attributes or mask are not valid for the node</li> </ul> <p><em>Not every implementation can detect each condition</em></p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs processing the event. </dd> <dt><b>See also</b></dt> <dd><a href="NodeAttribute.html">NodeAttribute</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addOrReplaceNode" class="membertitle">addOrReplaceNode</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>addOrReplaceNode</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName,</td> </tr> <tr> <td/><td valign="top">[in] short</td> <td valign="bottom"> aAttributes )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>receives notification that a node is started as a new item. </dd> <dd><p> The current node must be a set and a preexisting item (if any) must be removeable. </p> <p> The new item will be created from the default template of the set. </p> <p> Subsequent calls describe the difference from the template of properties, items or members of the node until a matching call to <a href="XUpdateHandler.html">XUpdateHandler</a>::<a href="XUpdateHandler.html#endNode">endNode()</a> is encountered. </p> </dd> <dt><b>Parameter aName</b></dt> <dd>specifies the name of the new item. </dd> <dt><b>Parameter aAttributes</b></dt> <dd>specifies attribute values to be applied to the new node. <p> The value is a combination of <a href="NodeAttribute.html">NodeAttribute</a> flags. Note that <a href="NodeAttribute.html">NodeAttribute</a>::<a href="NodeAttribute.html#FUSE">FUSE</a> has an impact on the semantics of this method. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there isn't a set node in progress currently</li> <li>if there already was a change to an item of that name</li> <li>if the template for the new node is not found</li> <li>if an item of that name exists and is not removeable</li> <li>if the name is not a valid item name</li> <li>if the attributes are not valid for the node</li> </ul> <p><em>Not every implementation can detect each condition</em></p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs processing the event. </dd> <dt><b>See also</b></dt> <dd><a href="NodeAttribute.html">NodeAttribute</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addOrReplaceNodeFromTemplate" class="membertitle">addOrReplaceNodeFromTemplate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>addOrReplaceNodeFromTemplate</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName,</td> </tr> <tr> <td/><td valign="top">[in] short</td> <td valign="bottom"> aAttributes,</td> </tr> <tr> <td/><td valign="top">[in] <a href="TemplateIdentifier.html">TemplateIdentifier</a></td> <td valign="bottom"> aTemplate )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>receives notification that a node is started as a new item based on a particular template. </dd> <dd><p> The current node must be a set and a preexisting item (if any) must be removeable. </p> <p> Subsequent calls describe the difference from the template of properties or members of the node until a matching call to <a href="XUpdateHandler.html">XUpdateHandler</a>::<a href="XUpdateHandler.html#endNode">endNode()</a> is encountered. </p> </dd> <dt><b>Parameter aName</b></dt> <dd>specifies the name of the item. </dd> <dt><b>Parameter aTemplate</b></dt> <dd>specifies the template to use for the new node </dd> <dt><b>Parameter aAttributes</b></dt> <dd>specifies attribute values to be applied to the new node. <p> The value is a combination of <a href="NodeAttribute.html">NodeAttribute</a> flags. Note that <a href="NodeAttribute.html">NodeAttribute</a>::<a href="NodeAttribute.html#FUSE">FUSE</a> has an impact on the semantics of this method. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there isn't a set node in progress currently</li> <li>if there already was a change to an item of that name</li> <li>if the template for the new node is not found</li> <li>if an item of that name exists and is not removeable</li> <li>if the name is not a valid item name</li> <li>if the template is not a valid item type for the containing set</li> <li>if the attributes are not valid for the node</li> </ul> <p><em>Not every implementation can detect each condition</em></p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs processing the event. </dd> <dt><b>See also</b></dt> <dd><a href="NodeAttribute.html">NodeAttribute</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="endNode" class="membertitle">endNode</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>endNode</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>receives notification that a node modification is complete. </dd> <dd><p> Must match the last open call to <a href="XUpdateHandler.html">XUpdateHandler</a>::<a href="XUpdateHandler.html#modifyNode">modifyNode()</a>, <a href="XUpdateHandler.html">XUpdateHandler</a>::<a href="XUpdateHandler.html#addOrReplaceNode">addOrReplaceNode()</a> or <a href="XUpdateHandler.html">XUpdateHandler</a>::<a href="XUpdateHandler.html#addOrReplaceNodeFromTemplate">addOrReplaceNodeFromTemplate()</a>. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if invalid data is detected in the node</li> <li>if no node is started at all</li> </ul> <p><em>Not every implementation can detect each condition</em></p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs processing the event. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeNode" class="membertitle">removeNode</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removeNode</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>receives notification that an item is to be dropped from a set. </dd> <dd><p> The current node must be a set and the item must be removeable. </p> </dd> <dt><b>Parameter aName</b></dt> <dd>specifies the name of the node. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there isn't a set node in progress currently</li> <li>if there already was a change to a node of that name</li> <li>if there is no item with that name</li> <li>if the item is not removeable</li> <li>if the name is not a valid node name</li> </ul> <p><em>Not every implementation can detect each condition</em></p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs processing the event. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="modifyProperty" class="membertitle">modifyProperty</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>modifyProperty</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName,</td> </tr> <tr> <td/><td valign="top">[in] short</td> <td valign="bottom"> aAttributes,</td> </tr> <tr> <td/><td valign="top">[in] short</td> <td valign="bottom"> aAttributeMask,</td> </tr> <tr> <td/><td valign="top">[in] type</td> <td valign="bottom"> aType )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>receives notification that modification of an existing property is started. . </dd> <dd><p> Subsequent calls describe changes to the value(s) of the property until a matching call to <a href="XUpdateHandler.html">XUpdateHandler</a>::<a href="XUpdateHandler.html#endProperty">endProperty()</a> is encountered. </p> </dd> <dt><b>Parameter aName</b></dt> <dd>specifies the name of the property. </dd> <dt><b>Parameter aAttributes</b></dt> <dd>specifies new attributes of the property. <p> The value is a combination of <a href="NodeAttribute.html">NodeAttribute</a> flags. </p> <p> Only attributes which are selected in aAttributeMask are changed. </p> <p> <b>NodeAttribute::MANDATORY</b> need not be set and can't be removed, as dynamic properties always are mandatory in subsequent layers. </p> </dd> <dt><b>Parameter aAttributeMask</b></dt> <dd>specifies which attributes should be changed for the property. <p> The value is a combination of <a href="NodeAttribute.html">NodeAttribute</a> flags. </p> </dd> <dt><b>Parameter aType</b></dt> <dd>specifies the type of the property. <p> A <b>void</b> type can be used to signify that the type is unknown and should not be recorded. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there isn't a group or extensible node in progress currently</li> <li>if there already was a change to a property of that name</li> <li>if there is no property with that name</li> <li>if the property is read-only</li> <li>if the name is not a valid property name</li> <li>if the attributes are not valid for the property</li> </ul> <p><em>Not every implementation can detect each condition</em></p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs processing the event. </dd> <dt><b>See also</b></dt> <dd><a href="NodeAttribute.html">NodeAttribute</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setPropertyValue" class="membertitle">setPropertyValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setPropertyValue</b>(</td> <td valign="top">[in] any</td> <td valign="bottom"> aValue )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>receives notification about a change to the value of the current property. </dd> <dt><b>Parameter aValue</b></dt> <dd>specifies the new value of the property. <p> The value must match the type of the existing property. If the property does not have the <b>SchemaAttribute::REQUIRED</b> flag set, the value can be <b>void</b>. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there isn't a property modification in progress currently</li> <li>if there already was a change to this value</li> <li>if the type of the value is not an allowed type</li> <li>if the value is not valid for the property</li> </ul> <p><em>Not every implementation can detect each condition</em></p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs processing the event. </dd> <dt><b>See also</b></dt> <dd><a href="NodeAttribute.html">NodeAttribute</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setPropertyValueForLocale" class="membertitle">setPropertyValueForLocale</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setPropertyValueForLocale</b>(</td> <td valign="top">[in] any</td> <td valign="bottom"> aValue,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aLocale )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>receives notification about a change to the value of the current property for a specific locale. </dd> <dt><b>Parameter aValue</b></dt> <dd>specifies the new value of the property for the given locale. <p> The value must match the type of the existing property. If the property does not have the <b>SchemaAttribute::REQUIRED</b> flag set, the value can be <b>void</b>. </p> </dd> <dt><b>Parameter aLocale</b></dt> <dd>specifies the locale that the new value applies to. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there isn't a property modification in progress currently</li> <li>if the property is not localizable</li> <li>if there already was a change to this value</li> <li>if the type of the value is not an allowed type</li> <li>if the value is not valid for the property</li> <li>if the locale is not a valid locale name</li> </ul> <p><em>Not every implementation can detect each condition</em></p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs processing the event. </dd> <dt><b>See also</b></dt> <dd><a href="NodeAttribute.html">NodeAttribute</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="resetPropertyValue" class="membertitle">resetPropertyValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>resetPropertyValue</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>receives notification that the value of the current property should be reset to its default. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there isn't a property modification in progress currently</li> <li>if there already was a change to this value</li> </ul> <p><em>Not every implementation can detect each condition</em></p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs processing the event. </dd> <dt><b>See also</b></dt> <dd><a href="NodeAttribute.html">NodeAttribute</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="resetPropertyValueForLocale" class="membertitle">resetPropertyValueForLocale</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>resetPropertyValueForLocale</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aLocale )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>receives notification that the value of the current property for a specific locale should be reset to its default. </dd> <dt><b>Parameter aLocale</b></dt> <dd>specifies the locale the change applies to. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there isn't a property modification in progress currently</li> <li>if the property is not localizable</li> <li>if there already was a change to this value</li> <li>if the locale is not a valid locale name</li> </ul> <p><em>Not every implementation can detect each condition</em></p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs processing the event. </dd> <dt><b>See also</b></dt> <dd><a href="NodeAttribute.html">NodeAttribute</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="endProperty" class="membertitle">endProperty</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>endProperty</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>receives notification that a property modification is complete. </dd> <dd><p> Must match the last open call to <a href="XUpdateHandler.html">XUpdateHandler</a>::<a href="XUpdateHandler.html#modifyProperty">modifyProperty()</a>. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if invalid data is detected in the property</li> <li>if no property is started at all</li> </ul> <p><em>Not every implementation can detect each condition</em></p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs processing the event. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="resetProperty" class="membertitle">resetProperty</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>resetProperty</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>receives notification that a property is reset to its default state. </dd> <dt><b>Parameter aName</b></dt> <dd>specifies the name of the property. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there isn't a group or extensible node in progress currently</li> <li>if there already was a change to a property of that name</li> <li>if there is no property with that name, or if the property has no default</li> <li>if the property is read-only</li> <li>if the name is not a valid property name</li> </ul> <p><em>Not every implementation can detect each condition</em></p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs processing the event. </dd> <dt><b>See also</b></dt> <dd><a href="NodeAttribute.html">NodeAttribute</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addOrReplaceProperty" class="membertitle">addOrReplaceProperty</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>addOrReplaceProperty</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName,</td> </tr> <tr> <td/><td valign="top">[in] short</td> <td valign="bottom"> aAttributes,</td> </tr> <tr> <td/><td valign="top">[in] type</td> <td valign="bottom"> aType )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>receives notification that a property having a value of <b>void</b> is added to the current node. </dd> <dd><p> The current node must be extensible and a preexisting property (if any) must be removeable in this layer. </p> </dd> <dt><b>Parameter aName</b></dt> <dd>specifies the name of the new property. </dd> <dt><b>Parameter aAttributes</b></dt> <dd>specifies the attributes of the new property. <p> The value is a combination of <a href="NodeAttribute.html">NodeAttribute</a> flags and may also contain the <b>SchemaAttribute::REQUIRED</b> flag. </p> </p> <p> <b>NodeAttribute::MANDATORY</b> need not be set, as dynamic properties always are mandatory in subsequent layers. </p> </dd> <dt><b>Parameter aType</b></dt> <dd>specifies the type of the new property. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there isn't a group or extensible node in progress currently</li> <li>if there already was a change to a property of that name</li> <li>if a property of that name exists and is not removeable</li> <li>if the specified type is not allowed</li> <li>if the name is not a valid property name</li> <li>if the attributes are not valid for the property</li> </ul> <p><em>Not every implementation can detect each condition</em></p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs processing the event. </dd> <dt><b>See also</b></dt> <dd><a href="SchemaAttribute.html">SchemaAttribute</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addOrReplacePropertyWithValue" class="membertitle">addOrReplacePropertyWithValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>addOrReplacePropertyWithValue</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName,</td> </tr> <tr> <td/><td valign="top">[in] short</td> <td valign="bottom"> aAttributes,</td> </tr> <tr> <td/><td valign="top">[in] any</td> <td valign="bottom"> aValue )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>receives notification that a property having a non-<b>NULL</b> value is added to the current node. </dd> <dd><p> The current node must be extensible and a preexisting property (if any) must be removeable in this layer. </p> </dd> <dt><b>Parameter aName</b></dt> <dd>specifies the name of the new property. </dd> <dt><b>Parameter aAttributes</b></dt> <dd>specifies the attributes of the new property. <p> The value is a combination of <a href="NodeAttribute.html">NodeAttribute</a> flags and may also contain the <b>SchemaAttribute::REQUIRED</b> flag. </p> </p> <p> <b>NodeAttribute::MANDATORY</b> need not be set, as dynamic properties always are mandatory in subsequent layers. </p> </dd> <dt><b>Parameter aValue</b></dt> <dd>specifies the value of the new property. <p> The value also determines the type. Therefore the value must not be <b>void</b>. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there isn't a group or extensible node in progress currently</li> <li>if there already was a change to a property of that name</li> <li>if a property of that name exists and is not removeable</li> <li>if the type of the value is not an allowed type, or if the value is <b>void</b></li> <li>if the name is not a valid property name</li> <li>if the attributes are not valid for the property</li> </ul> <p><em>Not every implementation can detect each condition</em></p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs processing the event. </dd> <dt><b>See also</b></dt> <dd><a href="SchemaAttribute.html">SchemaAttribute</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeProperty" class="membertitle">removeProperty</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removeProperty</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>receives notification that a property is dropped from the current node. </dd> <dd><p>The current node must be extensible and the property removeable.</p> </dd> <dt><b>Parameter aName</b></dt> <dd>specifies the name of the property. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there isn't a group or extensible node in progress currently</li> <li>if there is no property with that name</li> <li>if the property is not removeable</li> <li>if the name is not a valid node name</li> </ul> <p><em>Not every implementation can detect each condition</em></p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs processing the event. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
2070
