<html> <head> <title>Interface XUIElementFactoryRegistration</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="XUIElementFactoryRegistration-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 XUIElementFactoryRegistration</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>is used to query, register and deregister user interface element factories. </dd> <dd><p> A user interface element factory is registered for a set of three properties. <ul> <li><b>Type</b>a string that identifies a type of a user interface element.</li> <li><b>Name</b>a string that identifies a single user interface element within a type class.</li> <li><b>Module</b>a string that identifies a single module of OpenOffice.</li> <ul> A combination of these three property values can uniquely identify every user interface element within OpenOffice. Currently the following user interface element types are defined: <ul> <li><b>menubar</b></li> <li><b>popupmenu</b></li> <li><b>toolbar</b></li> <li><b>statusbar</b></li> <li><b>floater</b></li> </ul> </p> </dd> <dt><b>Since </b></dt> <dd>OOo 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="#getRegisteredFactories">getRegisteredFactories</a></td> <td class="imsum_right">function to retrieve a list of all registered user interface element factories </td> </tr> <tr> <td class="imsum_left"><a href="#getFactory">getFactory</a></td> <td class="imsum_right">function to retrieve a previously registered user interface element factory. </td> </tr> <tr> <td class="imsum_left"><a href="#registerFactory">registerFactory</a></td> <td class="imsum_right">function to register a user interface element factory. </td> </tr> <tr> <td class="imsum_left"><a href="#deregisterFactory">deregisterFactory</a></td> <td class="imsum_right">function to remove a previously defined user interface element factory. </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="getRegisteredFactories" class="membertitle">getRegisteredFactories</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>getRegisteredFactories</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>function to retrieve a list of all registered user interface element factories </dd> <dt><b>Returns</b></dt> <dd>a sequence of sequence of property values which describe every registered user interface element factory.<br/> The following properties are defined: <ul> <li><b>Type</b>a string property that identifies the type of the user interface element which this factory can create.</li> <li><b>Name</b>an optional string property which identifies a single user interface element within a type class which this factory can create. If this property is not returned, the factory is a generic factory for all user interface elements of the same type.</li> <li><b>Module</b>an optional string property that specifies to which module this factory is bound to. If this property is not returned, the factory is a generic factory.</li> </ul> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getFactory" class="membertitle">getFactory</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"><a href="XUIElementFactory.html">XUIElementFactory</a></td> </tr> <tr> <td valign="top"><b>getFactory</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> ResourceURL,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> ModuleIdentifier );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>function to retrieve a previously registered user interface element factory. </dd> <dt><b>Returns</b></dt> <dd>a reference to a registered user interface element factory if a factory has been found. An empty reference when no factory has been found. <b>The defined search order of factories must be from special to generic ones.</b> </dd> <dt><b>Parameter ResourceURL</b></dt> <dd>a resource URL which identifies a user interface element. A resource URL uses the following syntax: "private:resource/$type/$name". It is only allowed to use ASCII characters for type and name. </dd> <dt><b>Parameter ModuleName</b></dt> <dd>an optional module identifier. This value can remain empty, if a generic factory is requested. The module identifier can be retrieved from the ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/ModuleManager.html">ModuleManager</a> service. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="registerFactory" class="membertitle">registerFactory</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>registerFactory</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aType,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aModuleIdentifier,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aFactoryImplementationName )</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> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>function to register a user interface element factory. </dd> <dt><b>Parameter aType</b></dt> <dd>a string that identifies a type of a user interface element. Currently the following types are supported: <ul> <li><b>menubar</b></li> <li><b>toolbar</b></li> <li><b>statusbar</b></li> </ul> </dd> <dt><b>Parameter aName</b></dt> <dd>an optional name of a single user interface element. This name must be unique within a user interface element type class. This value can remain empty if no special factory for a single user interface element is needed. </dd> <dt><b>Parameter aModuleIdentifier</b></dt> <dd>an optional module identifier that can be used to register a factory only for a single module. This value can remain empty if no special factory for a single module is needed. The module identifier can be retrieved from the ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/ModuleManager.html">ModuleManager</a> service. </dd> <dt><b>Parameter aFactoryImplementationName</b></dt> <dd>a UNO implementation name that can be used by an implementation to create a factory instance. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="deregisterFactory" class="membertitle">deregisterFactory</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>deregisterFactory</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aType,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aModuleIdentifier )</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> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>function to remove a previously defined user interface element factory. </dd> <dt><b>Parameter aType</b></dt> <dd>a string that identifies a type of a user interface element. Currently the following types are supported: <ul> <li><b>menubar</b></li> <li><b>toolbar</b></li> <li><b>statusbar</b></li> </ul> </dd> <dt><b>Parameter aName</b></dt> <dd>an optional name of a single user interface element. This name must be unique within a user interface element type class. This value can remain empty if no special factory for a single user interface element should be deregistered. </dd> <dt><b>Parameter aModuleName</b></dt> <dd>an optional module name that can be used to deregister a factory only for a single module. This value can remain empty if not a module based factory should be deregistered. The module identifier can be retrieved from the ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/ModuleManager.html">ModuleManager</a> service. <p> <b>Using this function can be very dangerous as other implementation with OpenOffice may not be able to create their user interface element anymore. </b> </p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
