<html> <head> <title>Interface XSchemaHandler</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="XSchemaHandler-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 XSchemaHandler</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>receives a description of a configuration schema 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="#startSchema">startSchema</a></td> <td class="imsum_right">receives notification that a schema description is started. </td> </tr> <tr> <td class="imsum_left"><a href="#endSchema">endSchema</a></td> <td class="imsum_right">receives notification that the current schema description is complete. </td> </tr> <tr> <td class="imsum_left"><a href="#importComponent">importComponent</a></td> <td class="imsum_right">receives notification that the schema depends on templates from a different component. </td> </tr> <tr> <td class="imsum_left"><a href="#startComponent">startComponent</a></td> <td class="imsum_right">receives notification that a component description is started. </td> </tr> <tr> <td class="imsum_left"><a href="#endComponent">endComponent</a></td> <td class="imsum_right">receives notification that a component description is complete. </td> </tr> <tr> <td class="imsum_left"><a href="#startGroupTemplate">startGroupTemplate</a></td> <td class="imsum_right">receives notification that a template description is started for a group. </td> </tr> <tr> <td class="imsum_left"><a href="#startSetTemplate">startSetTemplate</a></td> <td class="imsum_right">receives notification that a template description is started for a set. </td> </tr> <tr> <td class="imsum_left"><a href="#endTemplate">endTemplate</a></td> <td class="imsum_right">receives notification that a template description is complete. </td> </tr> <tr> <td class="imsum_left"><a href="#startGroup">startGroup</a></td> <td class="imsum_right">receives notification that a group description is started. </td> </tr> <tr> <td class="imsum_left"><a href="#startSet">startSet</a></td> <td class="imsum_right">receives notification that a set description is started. </td> </tr> <tr> <td class="imsum_left"><a href="#endNode">endNode</a></td> <td class="imsum_right">receives notification that a node description is complete. </td> </tr> <tr> <td class="imsum_left"><a href="#addProperty">addProperty</a></td> <td class="imsum_right">receives notification that a property is added to the current node. </td> </tr> <tr> <td class="imsum_left"><a href="#addPropertyWithDefault">addPropertyWithDefault</a></td> <td class="imsum_right">receives notification that a property having a default value is added to the current node. </td> </tr> <tr> <td class="imsum_left"><a href="#addInstance">addInstance</a></td> <td class="imsum_right">receives notification that the current group has a child node that is an instance of a specified template. </td> </tr> <tr> <td class="imsum_left"><a href="#addItemType">addItemType</a></td> <td class="imsum_right">receives notification that the current set can contain items that are instances of a specified template. </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="startSchema" class="membertitle">startSchema</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>startSchema</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 schema description is started. </dd> <dd><p> The schema descrption may comprise components templates or both. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException if a schema is already started (and has not been ended). </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="endSchema" class="membertitle">endSchema</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>endSchema</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 current schema description is complete. </dd> <dd><p> Must match a previous call to <a href="#startSchema">startSchema</a>. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if invalid data is detected in the schema</li> <li>if there is a unfinished component or template in progress</li> <li>if no schema 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="importComponent" class="membertitle">importComponent</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>importComponent</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 the schema depends on templates from a different component. </dd> <dt><b>Parameter aName</b></dt> <dd>specifies the name of the component. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there is a unfinished component or template in progress</li> <li>if no schema is started at all</li> <li>if the name is not a valid component name</li> <li>if the requested component is not found</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="startComponent" class="membertitle">startComponent</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>startComponent</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 component description is started. </dd> <dd><p> Subsequent calls describe the schema of the component until a matching call to <a href="#endComponent">endComponent</a> is encountered. </p> </dd> <dt><b>Parameter aName</b></dt> <dd>specifies the name of the component. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there is a unfinished component or template in progress </li> <li>if no schema is started at all </li> <li>if there already is a component data tree of this name</li> <li>if the name is not a valid component name</li> <li>if the instance supports no component schemas (only templates)</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="endComponent" class="membertitle">endComponent</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>endComponent</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 component description is complete. </dd> <dd><p> Must match a previous call to <a href="#startComponent">startComponent</a>. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if invalid data is detected in the component<li> <li>if there is a unfinished subnode in progress<li> <li>if no component has been started at all<li> <li>if the instance supports no component schemas (only templates)<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="startGroupTemplate" class="membertitle">startGroupTemplate</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>startGroupTemplate</b>(</td> <td valign="top">[in] <a href="TemplateIdentifier.html">TemplateIdentifier</a></td> <td valign="bottom"> aTemplate,</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 template description is started for a group. </dd> <dd><p> Subsequent calls describe the members and properties of the template until a matching call to <a href="#endTemplate">endTemplate</a> is encountered. </p> </dd> <dt><b>Parameter aTemplate</b></dt> <dd>specifies the identity of the template. </dd> <dt><b>Parameter aAttributes</b></dt> <dd>specifies the attributes of the template. <p> The value is a combination of <a href="SchemaAttribute.html">SchemaAttribute</a> flags. </p> <p> <b>SchemaAttribute::EXTENSIBLE</b> can be used to describe a template for a node with an extensible set of properties. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there is a unfinished component or template in progress</li> <li>if no schema is started at all </li> <li>if there already is a template with that identifier</li> <li>if the name is not a valid template identifier </li> <li>if the attributes are not valid for a group</li> <li>if the instance supports no templates (only component schemas)</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="startSetTemplate" class="membertitle">startSetTemplate</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>startSetTemplate</b>(</td> <td valign="top">[in] <a href="TemplateIdentifier.html">TemplateIdentifier</a></td> <td valign="bottom"> aTemplate,</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"> aItemType )</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 template description is started for a set. </dd> <dd><p> Subsequent calls describe the members and properties of the template until a matching call to <a href="#endTemplate">endTemplate</a> is encountered. </p> </dd> <dt><b>Parameter aTemplate</b></dt> <dd>specifies the identity of the template. </dd> <dt><b>Parameter aAttributes</b></dt> <dd>specifies the attributes of the template. <p> The value is a combination of <a href="SchemaAttribute.html">SchemaAttribute</a> flags. </p> <p> <b>SchemaAttribute::EXTENSIBLE</b> can be used to describe a template for a node with an extensible set of properties. </p> </dd> <dt><b>Parameter aItemType</b></dt> <dd>specifies the (default) template for set items. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there is a unfinished component or template in progress</li> <li>if no schema is started at all </li> <li>if there already is a template with that identifier</li> <li>if the item-type template is not found</li> <li>if the name or item-type are not valid template identifiers </li> <li>if the attributes are not valid for a set</li> <li>if the instance supports no templates (only component schemas).</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="endTemplate" class="membertitle">endTemplate</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>endTemplate</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 template description is complete. </dd> <dd><p> Must match a previous call to <a href="#startGroupTemplate">startGroupTemplate</a> or <a href="#startSetTemplate">startSetTemplate</a>. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if invalid data is detected in the template</li> <li>if there is a unfinished subnode in progress</li> <li>if no template has been started at all</li> <li>if the instance supports no templates (only component schemas)</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="startGroup" class="membertitle">startGroup</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>startGroup</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 group description is started. </dd> <dd><p> Subsequent calls describe the members and properties of the group until a matching call to <a href="#endNode">endNode</a> is encountered. </p> </dd> <dt><b>Parameter aName</b></dt> <dd>specifies the name of the group. </dd> <dt><b>Parameter aAttributes</b></dt> <dd>specifies the attributes of the node. <p> The value is a combination of <a href="SchemaAttribute.html">SchemaAttribute</a> flags. </p> <p> <b>SchemaAttribute::EXTENSIBLE</b> can be used to describe a group with an extensible set of properties. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there isn't a group node in progress currently</li> <li>if there already is a node with that name</li> <li>if the name is not a valid node name</li> <li>if the attributes are not valid for a group</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="startSet" class="membertitle">startSet</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>startSet</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"> aItemType )</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 set description is started. </dd> <dd><p> Subsequent calls describe the item-types and properties of the set until a matching call to <a href="#endNode">endNode</a> is encountered. </p> </dd> <dt><b>Parameter aName</b></dt> <dd>specifies the name of the set. </dd> <dt><b>Parameter aAttributes</b></dt> <dd>specifies the attributes of the node. <p> The value is a combination of <a href="SchemaAttribute.html">SchemaAttribute</a> flags. </p> <p> <b>SchemaAttribute::EXTENSIBLE</b> can be used to describe a set with an extensible set of properties. </p> </dd> <dt><b>Parameter aItemType</b></dt> <dd>specifies the (default) template for set items. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there isn't a group node in progress currently</li> <li>if there already is a node with that name</li> <li>if the item-type template is not found</li> <li>if the name is not a valid node name</li> <li>if the item-type is not a valid template identifier</li> <li>if the attributes are not valid for a set</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="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 description is complete. </dd> <dd><p> Must match the last open call to <a href="#startGroup">startGroup</a> or <a href="#startSet">startSet</a>. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if the name is not a the name of the node in progress</li> <li>if invalid data is detected in the node</li> <li>if no node has been 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="addProperty" class="membertitle">addProperty</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>addProperty</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 is added to the current node. </dd> <dd><p> The property will have a default value of <b>NULL</b> (unless it is <b>SchemaAttribute::REQUIRED</b>). </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="SchemaAttribute.html">SchemaAttribute</a> flags. </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 a property with the same name already exists</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 a 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="addPropertyWithDefault" class="membertitle">addPropertyWithDefault</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>addPropertyWithDefault</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"> aDefaultValue )</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 default value is added to the current node. </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="SchemaAttribute.html">SchemaAttribute</a> flags. </p> </dd> <dt><b>Parameter aDefaultValue</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 a property with the same name already exists</li> <li>if the type of the default value is not an allowed type, or if the default 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 a 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="addInstance" class="membertitle">addInstance</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>addInstance</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName,</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 the current group has a child node that is an instance of a specified template. </dd> <dt><b>Parameter aName</b></dt> <dd>specifies the name of the new node. </dd> <dt><b>Parameter aTemplate</b></dt> <dd>specifies a template that describes the new node. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException <ul> <li>if there isn't a group node in progress currently</li> <li>if there already is a node with that name</li> <li>if the template is not found</li> <li>if the name or template name are not valid</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="addItemType" class="membertitle">addItemType</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>addItemType</b>(</td> <td valign="top">[in] <a href="TemplateIdentifier.html">TemplateIdentifier</a></td> <td valign="bottom"> aItemType )</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 current set can contain items that are instances of a specified template. </dd> <dt><b>Parameter aItemType</b></dt> <dd>specifies a template that is accepted as valid item type for the current set 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 the template is not found</li> <li>if the name is not a valid template 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
>
2062
