<html> <head> <title>Interface XDesktop</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="XDesktop-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Using_the_Desktop" class="navimain">Devguide</a></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">frame</a> :: </p> </td> </tr> <tr> <td class="title">interface XDesktop</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This is the main interface of a desktop service. </dd> <dd><p> A desktop is an environment for components which can be viewed in frames. Frames are like frames in HTML framesets. This does not imply that a desktop can handle framesets; the frames may be top frames only. </p> </dd> <dt><b>See also</b></dt> <dd><a href="Desktop.html">Desktop</a></dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Using_the_Desktop">OfficeDev - Using the Desktop</a></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="#terminate">terminate</a></td> <td class="imsum_right">tries to terminate the desktop. </td> </tr> <tr> <td class="imsum_left"><a href="#addTerminateListener">addTerminateListener</a></td> <td class="imsum_right">registers an event listener to the desktop, which is called when the desktop is queried to terminate, and when it really terminates. </td> </tr> <tr> <td class="imsum_left"><a href="#removeTerminateListener">removeTerminateListener</a></td> <td class="imsum_right">unregisters an event listener for termination events. </td> </tr> <tr> <td class="imsum_left"><a href="#getComponents">getComponents</a></td> <td class="imsum_right">provides read access to collection of all currently loaded components inside the frame tree </td> </tr> <tr> <td class="imsum_left"><a href="#getCurrentComponent">getCurrentComponent</a></td> <td class="imsum_right">provides read access to the component inside the tree which has the UI focus </td> </tr> <tr> <td class="imsum_left"><a href="#getCurrentFrame">getCurrentFrame</a></td> <td class="imsum_right">provides read access to the frame wich contains the current component </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="terminate" class="membertitle">terminate</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>terminate</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>tries to terminate the desktop. </dd> <dd><p> First, every terminate listener is called by his <a href="XTerminateListener.html">XTerminateListener</a>::<a href="XTerminateListener.html#queryTermination">queryTermination()</a> method. Throwing of a <a href="TerminationVetoException.html">TerminationVetoException</a> can break the termination process and the listener how has done that will be the new "controller" of the desktop lifetime. He should try to terminate it by himself after his own processes will be finished. If nobody disagree with the termination request, every listener will be called by his <a href="XTerminateListener.html">XTerminateListener</a>::<a href="XTerminateListener.html#notifyTermination">notifyTermination()</a> method. </p> </dd> <dt><b>Returns</b></dt> <dd><b>true</b>if all listener agree with this request <br> <b>false</b>otherwise </dd> <dt><b>See also</b></dt> <dd><a href="XTerminateListener.html">XTerminateListener</a>, <a href="TerminationVetoException.html">TerminationVetoException</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addTerminateListener" class="membertitle">addTerminateListener</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">[oneway] void</td> </tr> <tr> <td valign="top"><b>addTerminateListener</b>(</td> <td valign="top">[in] <a href="XTerminateListener.html">XTerminateListener</a></td> <td valign="bottom"> Listener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>registers an event listener to the desktop, which is called when the desktop is queried to terminate, and when it really terminates. </dd> <dt><b>Parameter Listener</b></dt> <dd>listener for termination events </dd> <dt><b>See also</b></dt> <dd><a href="XDesktop.html">XDesktop</a>::<a href="XDesktop.html#removeTerminateListener">removeTerminateListener()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeTerminateListener" class="membertitle">removeTerminateListener</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">[oneway] void</td> </tr> <tr> <td valign="top"><b>removeTerminateListener</b>(</td> <td valign="top">[in] <a href="XTerminateListener.html">XTerminateListener</a></td> <td valign="bottom"> Listener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>unregisters an event listener for termination events. </dd> <dt><b>Parameter Listener</b></dt> <dd>listener which wish to be deregistered </dd> <dt><b>See also</b></dt> <dd><a href="XDesktop.html">XDesktop</a>::<a href="XDesktop.html#addTerminateListener">addTerminateListener()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getComponents" class="membertitle">getComponents</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/XEnumerationAccess.html">XEnumerationAccess</a></td> </tr> <tr> <td valign="top"><b>getComponents</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides read access to collection of all currently loaded components inside the frame tree </dd> <dd><p> The component is, by definition, the model of the control which is loaded into a frame, or if no model exists, into the control itself. The service <a href="Components.html">Components</a> which is available from this method is a collection of all components of the desktop which are open within a frame of the desktop. </p> </dd> <dt><b>Returns</b></dt> <dd>the collection of all components </dd> <dt><b>See also</b></dt> <dd><a href="Components.html">Components</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCurrentComponent" class="membertitle">getCurrentComponent</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="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></td> </tr> <tr> <td valign="top"><b>getCurrentComponent</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides read access to the component inside the tree which has the UI focus </dd> <dd><p> Normally, the component is the model part of the active component. If no model exists it is the active controller (view) itself. </p> </dd> <dt><b>Returns</b></dt> <dd>the component within the desktop environment which has the UI focus. </dd> <dt><b>See also</b></dt> <dd><a href="XDesktop.html">XDesktop</a>::<a href="XDesktop.html#getCurrentFrame">getCurrentFrame()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCurrentFrame" class="membertitle">getCurrentFrame</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="XFrame.html">XFrame</a></td> </tr> <tr> <td valign="top"><b>getCurrentFrame</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides read access to the frame wich contains the current component </dd> <dt><b>Returns</b></dt> <dd>the frame of the component which has the UI focus within this desktop enviroment </dd> <dt><b>See also</b></dt> <dd><a href="XDesktop.html">XDesktop</a>::<a href="XDesktop.html#getCurrentComponent">getCurrentComponent()</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>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
3517
