<html> <head> <title>Interface XUIElementSettings</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="XUIElementSettings-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">ui</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XUIElementSettings</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>provides functions to retrieve and change user interface element structure data and to update its visible representation. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 2.0</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="#updateSettings">updateSettings</a></td> <td class="imsum_right">forces the user interface element to retrieve new settings from its configuration source. </td> </tr> <tr> <td class="imsum_left"><a href="#getSettings">getSettings</a></td> <td class="imsum_right">provides a <a href="UIElementSettings.html">UIElementSettings</a> instance that provides access to the structure of user interface element if the user interface element type supports it. </td> </tr> <tr> <td class="imsum_left"><a href="#setSettings">setSettings</a></td> <td class="imsum_right">set changes to the structure of the user interface element. </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="updateSettings" class="membertitle">updateSettings</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>updateSettings</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>forces the user interface element to retrieve new settings from its configuration source. </dd> <dd><p> This is not done automatically as configurable user interface elements are controlled by layout managers. It is more efficient to let the responsible layout manager to control the update process in a single task. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSettings" class="membertitle">getSettings</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">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a></td> </tr> <tr> <td valign="top"><b>getSettings</b>(</td> <td valign="top">[in] boolean</td> <td valign="bottom"> bWriteable );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides a <a href="UIElementSettings.html">UIElementSettings</a> instance that provides access to the structure of user interface element if the user interface element type supports it. </dd> <dt><b>Parameter bWriteable</b></dt> <dd>must be <b>true</b> if the retrieved settings should be a writeable. Otherwise <b>false</b> should be provided to get a shareable reference to the settings data. </dd> <dt><b>Returns</b></dt> <dd>the current settings of the user interface element. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setSettings" class="membertitle">setSettings</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>setSettings</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a></td> <td valign="bottom"> UISettings );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>set changes to the structure of the user interface element. </dd> <dt><b>Parameter UISettings</b></dt> <dd>new data settings for the configurable user interface element. <p> User interface elements cannot be changed directly. The changed structure data has to be set again. This speeds up the configuration process if many changes have to be made on the structure. The persistence of changes are controlled by the boolean property <a href="#Persistent">Persistent</a>. </p> </dd> <dt><b>See also</b></dt> <dd><a href="UIElementSettings.html">UIElementSettings</a></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>