Sophie

Sophie

distrib > * > cooker > x86_64 > by-pkgid > 5fb1c39f9f9130a3cc01e8b1ffa5c0f8 > files > 782

libreoffice-devel-3.5.4-4.x86_64.rpm

<html>
<head>
<title>Interface XDialogProvider2</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="XDialogProvider2-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">awt</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 XDialogProvider2</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XDialogProvider2</strong>
&#x2517 <a href="XDialogProvider.html">XDialogProvider</a>

</pre></dd>
<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
<tr>
<td class="imsum_left"><a href="XDialogProvider.html">XDialogProvider</a></td>
<td class="imsum_right"><dl>
<dt>(referenced interface's summary:)</dt>
<dd>provides dialogs implementing the
 <a href="XDialog.html">XDialog</a> interface.
 </dd>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>not published</i></dd>
<dt><b>Description</b></dt>
<dd>provides dialogs implementing the
 <a href="XDialog.html">XDialog</a> interface.
 </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="#createDialogWithHandler">createDialogWithHandler</a></td>
<td class="imsum_right">creates a dialog for the given URL accepting an Interface used
 to handle dialog events.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#createDialogWithArguments">createDialogWithArguments</a></td>
<td class="imsum_right">creates a dialog for the given URL, accepting additional creation parameters

 &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="createDialogWithHandler" class="membertitle">createDialogWithHandler</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="XDialog.html">XDialog</a></td>
</tr>
<tr>
<td valign="top"><b>createDialogWithHandler</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;URL,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td>
<td valign="bottom">&nbsp;xHandler )</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>creates a dialog for the given URL accepting an Interface used
 to handle dialog events.

 </dd>
<dt><b>Parameter URL</b></dt>
<dd>is the URL.

 </dd>
<dt><b>Parameter xHandler</b></dt>
<dd>is the interface that will be called to handle the Events that
 are generated by the dialog (and all controls placed on it) and
 bound to the handler using a vnd.sun.star.UNO URL specifying a
 handler method to be called. Usually this will be done directly
 by the user.

 xHandler can handle events in two different ways:

 1. By supporting the <a href="XDialogEventHandler.html">XDialogEventHandler</a> interface.
 This is a generic interface to accept event notifications.

 2. By providing interfaces that directly implement the handler
 methods to be called. The XDialogProvider2 implementation then
 will try to access these events using the
 ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/Introspection.html">Introspection</a>Introspection
 service. To make this possible the handler implementation also has to
 support ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XTypeProvider.html">XTypeProvider</a>.

 If XDialogEventHandler is supported XDialogEventHandler.callHandlerMethod()
 is always called first to handle the event. Only if the event cannot be
 handled by XDialogEventHandler (callHandlerMethod() then has to return
 false) or if XDialogEventHandler is not supported at all the Introspection
 based access will be used.

 The Introspection based access tries to call a method named according to the
 HandlerMethodName specified by a vnd.sun.star.UNO:<HandlerMethodName> URL.
 First a method

 void HandlerMethodName( [in] com::sun::star::awt::XDialog xDialog, [in] any aEvent )

 will be searched. The signature is similar to XDialogEventHandler.
 callHandlerMethod except for MethodName itself that isn't needed
 here. For more information about these parameters, see
 <a href="XDialogEventHandler.html">XDialogEventHandler</a>.

 If this method is found, it will be called, otherwise a method

 void HandlerMethodName( void )

 will be searched and called.

 </dd>
<dt><b>Returns</b></dt>
<dd>a dialog implementing the <a href="XDialog.html">XDialog</a> interface.

 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::lang::IllegalArgumentException
 if no dialog for the given URL is found or if the URL is invalid
 or xHandler is null.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="XDialogEventHandler.html">XDialogEventHandler</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="createDialogWithArguments" class="membertitle">createDialogWithArguments</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="XDialog.html">XDialog</a></td>
</tr>
<tr>
<td valign="top"><b>createDialogWithArguments</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;URL,</td>
</tr>
<tr>
<td/><td valign="top">[in] sequence&lt; ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/NamedValue.html">NamedValue</a> &gt;</td>
<td valign="bottom">&nbsp;Arguments )</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>creates a dialog for the given URL, accepting additional creation parameters

 </dd>
<dd><p>The arguments accepted so far are
 <ul><li><em>ParentWindow</em> - must be a component supporting the <a href="XWindowPeer.html">XWindowPeer</a> interface,
 or a component supporting the <a href="XControl.html">XControl</a> interface, so an <code>XWindowPeer</code> can be
 obtained from it. The given window will be used as parent window for the to-be-created dialog.</li>
 <li><em>EventHandler</em> - specifies a component handling events in the dialog. See
 <a href="#createDialogWithHandler">createDialogWithHandler</a> for a detailed specification of dialog event handling.</li>
 </ul>
 </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 &copy; 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>&nbsp;</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>