<html> <head> <title>Interface XUIConfigurationManager</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="XUIConfigurationManager-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 XUIConfigurationManager</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>specifies a user interface configuration manager interface which controls the structure of all customizable user interface elements. </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="#reset">reset</a></td> <td class="imsum_right">resets the configuration manager to the default user interface configuration data. </td> </tr> <tr> <td class="imsum_left"><a href="#getUIElementsInfo">getUIElementsInfo</a></td> <td class="imsum_right">retrieves information about all user interface elements within the user interface configuration manager. </td> </tr> <tr> <td class="imsum_left"><a href="#createSettings">createSettings</a></td> <td class="imsum_right">creates an empty settings data container. </td> </tr> <tr> <td class="imsum_left"><a href="#hasSettings">hasSettings</a></td> <td class="imsum_right">determines if the settings of a user interface element is part the user interface configuration manager. </td> </tr> <tr> <td class="imsum_left"><a href="#getSettings">getSettings</a></td> <td class="imsum_right">retrieves the settings of a user interface element. </td> </tr> <tr> <td class="imsum_left"><a href="#replaceSettings">replaceSettings</a></td> <td class="imsum_right">replaces the settings of a user interface element with new settings. </td> </tr> <tr> <td class="imsum_left"><a href="#removeSettings">removeSettings</a></td> <td class="imsum_right">removes the settings of an existing user interface element. </td> </tr> <tr> <td class="imsum_left"><a href="#insertSettings">insertSettings</a></td> <td class="imsum_right">inserts the settings of a new user interface element. </td> </tr> <tr> <td class="imsum_left"><a href="#getImageManager">getImageManager</a></td> <td class="imsum_right">retrieves the image manager from the user interface configuration manager. </td> </tr> <tr> <td class="imsum_left"><a href="#getShortCutManager">getShortCutManager</a></td> <td class="imsum_right">retrieves the keyboard short cut manager from the user interface configuration manager. </td> </tr> <tr> <td class="imsum_left"><a href="#getEventsManager">getEventsManager</a></td> <td class="imsum_right">retrieves the events manager from the user interface configuration manager. </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="reset" class="membertitle">reset</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>reset</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>resets the configuration manager to the default user interface configuration data. </dd> <dd><p> This means that all user interface configuration data of the instance will be removed. A module based user interface configuration manager removes user defined elements, but set all other elements back to default. It is not possible to remove default elements from a module user interface configuration manager. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getUIElementsInfo" class="membertitle">getUIElementsInfo</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">sequence< sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> > ></td> </tr> <tr> <td valign="top"><b>getUIElementsInfo</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> ElementType )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves information about all user interface elements within the user interface configuration manager. </dd> <dt><b>Parameter ElementType</b></dt> <dd>makes it possible to narrow the result set to only one type of user interface elements. If all user interface element types should be returned <value scope=com::sun::star::ui>UIElementType::UNKNOWN</value> must be provided. </dd> <dt><b>Returns</b></dt> <dd>returns all user interface elements within the user interface configuration manager that meet the given ElementType specification. <p>The following ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> entries are defined inside the sequence for every user interface element. <ul> <li><b>ResourceURL<b/>specifies the unique resource URL for the user interface element.</li> <li><b>UIName<b/>specifies the user interface name for the user interface element. Not all user interface elements have set UIName. At least menubars do not.</li> </ul> <p> </dd> <dt><b>See also</b></dt> <dd><a href="UIElementType.html">UIElementType</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createSettings" class="membertitle">createSettings</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/XIndexContainer.html">XIndexContainer</a></td> </tr> <tr> <td valign="top"><b>createSettings</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates an empty settings data container. </dd> <dt><b>Returns</b></dt> <dd>an empty user interface element settings data container, which implements <a href="UIElementSettings.html">UIElementSettings</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasSettings" class="membertitle">hasSettings</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">boolean</td> </tr> <tr> <td valign="top"><b>hasSettings</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> ResourceURL )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines if the settings of a user interface element is part the user interface configuration manager. </dd> <dt><b>Parameter ResourceURL</b></dt> <dd>a resource URL which identifies the user interface element. A resourcce URL must meet the following syntax: "private:resource/$type/$name. It is only allowed to use ascii characters for type and name. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if settings have been found, otherwise <b>false</b>. </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] string</td> <td valign="bottom"> ResourceURL,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bWriteable )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the settings of a user interface element. </dd> <dt><b>Parameter ResourceURL</b></dt> <dd>a resource URL which identifies the user interface element. A resourcce URL must meet the following syntax: "private:resource/$type/$name. It is only allowed to use ascii characters for type and name. </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>settings data of an existing user interface element, which implements <a href="UIElementSettings.html">UIElementSettings</a>. If the settings data cannot be found a ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> is thrown. If the <a href="#ResourceURL">ResourceURL</a> is not valid or describes an unknown type a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> is thrown. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="replaceSettings" class="membertitle">replaceSettings</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>replaceSettings</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> ResourceURL,</td> </tr> <tr> <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"> aNewData )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalAccessException.html">IllegalAccessException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>replaces the settings of a user interface element with new settings. </dd> <dt><b>Parameter ResourceURL</b></dt> <dd>a resource URL which identifies the user interface element to be replaced. If no element with the given resource URL exists a ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> is thrown. </dd> <dt><b>Parameter aNewData</b></dt> <dd>the new settings data of an existing user interface element, which implements <a href="UIElementSettings.html">UIElementSettings</a>. <p> If the settings data cannot be found a ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> is thrown. If the <a href="#ResourceURL">ResourceURL</a> is not valid or describes an unknown type a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> is thrown. If the configuration manager is read-only a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalAccessException.html">IllegalAccessException</a> is thrown. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeSettings" class="membertitle">removeSettings</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>removeSettings</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> ResourceURL )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalAccessException.html">IllegalAccessException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes the settings of an existing user interface element. </dd> <dt><b>Parameter ResourceURL</b></dt> <dd>a resource URL which identifies the user interface element settings to be removed. <p> If the settings data cannot be found a ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> is thrown. If the <a href="#ResourceURL">ResourceURL</a> is not valid or describes an unknown type a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> is thrown. If the configuration manager is read-only a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalAccessException.html">IllegalAccessException</a> is thrown. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="insertSettings" class="membertitle">insertSettings</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>insertSettings</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> NewResourceURL,</td> </tr> <tr> <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"> aNewData )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/ElementExistException.html">ElementExistException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalAccessException.html">IllegalAccessException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>inserts the settings of a new user interface element. </dd> <dt><b>Parameter ResourceURL</b></dt> <dd>a resource URL which identifies the new user interface element. </dd> <dt><b>Parameter aNewData</b></dt> <dd>the settings data of the new user interface element, which implements <a href="UIElementSettings.html">UIElementSettings</a>. <p> If the settings data is already present a ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/ElementExistException.html">ElementExistException</a> is thrown. If the <a href="#ResourceURL">ResourceURL</a> is not valid or describes an unknown type a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> is thrown. If the configuration manager is read-only a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalAccessException.html">IllegalAccessException</a> is thrown. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getImageManager" class="membertitle">getImageManager</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="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> </tr> <tr> <td valign="top"><b>getImageManager</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the image manager from the user interface configuration manager. </dd> <dd><p> Every user interface configuration manager has one image manager instance which controls all images of a module or document. </p> </dd> <dt><b>Returns</b></dt> <dd>the image manager of the user interface configuration manager. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getShortCutManager" class="membertitle">getShortCutManager</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="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> </tr> <tr> <td valign="top"><b>getShortCutManager</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the keyboard short cut manager from the user interface configuration manager. </dd> <dd><p> Every user interface configuration manager has one keyboard short cut manager instance which controls all short cuts of a module or document. </p> </dd> <dt><b>Returns</b></dt> <dd>the short cut manager of the user interface configuration manager. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getEventsManager" class="membertitle">getEventsManager</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="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> </tr> <tr> <td valign="top"><b>getEventsManager</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the events manager from the user interface configuration manager. </dd> <dd><p> Every user interface configuration manager has one events manager instance which controls the mapping of events to script URLs of a module or document. </p> </dd> <dt><b>Returns</b></dt> <dd>the events manager of the user interface configuration manager, if one exists. </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
>
7743
