Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 3568

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XUIControllerRegistration</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="XUIControllerRegistration-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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</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">frame</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XUIControllerRegistration</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>is used to query, register and unregister user interface controller.

 </dd>
<dd><p>
 A user interface controller can be registered for a command URL. A certain user 
 interface controller will be created when a user interface element contains a 
 registered command URL.
 
 </dd>
<dt><b/></dt>
<dd/><dt><b>See also</b></dt>
<dd><a href="PopupMenuControllerFactory.html">PopupMenuControllerFactory</a><br>
</p>
 
 </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="#hasController">hasController</a></td>
<td class="imsum_right">function to check if an user interface controller is registered
 for a command URL and optional module.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#registerController">registerController</a></td>
<td class="imsum_right">function to create an association between a user interface controller implementation 
 and a command URL and optional module.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#deregisterController">deregisterController</a></td>
<td class="imsum_right">function to remove a previously defined association between a user interface controller 
 implementation and a command URL and optional module.
 
 &nbsp;</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="hasController" class="membertitle">hasController</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>hasController</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aCommandURL,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aModelName );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>function to check if an user interface controller is registered
 for a command URL and optional module.

 </dd>
<dt><b>Returns</b></dt>
<dd>true if a controller was registered for the combination of command URL
 and model name.

 </dd>
<dt><b>Parameter aCommandURL</b></dt>
<dd>a command URL which specifies an action.

 </dd>
<dt><b>Parameter aModelName</b></dt>
<dd>an optional name of an OpenOffice model service. This value can remain empty if
 no model service name was specified.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="registerController" class="membertitle">registerController</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>registerController</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aCommandURL,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aModelName,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aControllerImplementationName );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>function to create an association between a user interface controller implementation 
 and a command URL and optional module.
 
 </dd>
<dt><b>Parameter aCommandURL</b></dt>
<dd>a command URL which specifies an action which shoudl be associated with a user
 interface controller.

 </dd>
<dt><b>Parameter aModelName</b></dt>
<dd>an optional name of an OpenOffice model service. This value can remain empty if
 no model service name was specified.

 </dd>
<dt><b>Parameter aControllerImplementationName</b></dt>
<dd>a UNO implementation name that can be used to create a user interface controller
 with the OpenOffice service manager.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="deregisterController" class="membertitle">deregisterController</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>deregisterController</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aCommandURL,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aModelName );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>function to remove a previously defined association between a user interface controller 
 implementation and a command URL and optional module.
 
 </dd>
<dt><b>Parameter aCommandURL</b></dt>
<dd>a command URL which specifies an action which shoudl be associated with a user
 interface controller.

 </dd>
<dt><b>Parameter aModelName</b></dt>
<dd>an optional name of an OpenOffice model service. This value can remain empty if
 no model service name was specified.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>