<html> <head> <title>Interface XInplaceClient</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="XInplaceClient-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">embed</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 XInplaceClient</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>represents common functionality for inplace clients. </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="#canInplaceActivate">canInplaceActivate</a></td> <td class="imsum_right">checks if the container can activate the object inplace. </td> </tr> <tr> <td class="imsum_left"><a href="#activatingInplace">activatingInplace</a></td> <td class="imsum_right">notifies container through the client that the object is to be inplace activated. </td> </tr> <tr> <td class="imsum_left"><a href="#activatingUI">activatingUI</a></td> <td class="imsum_right">notifies container through the client that the object is to be UI-activated. </td> </tr> <tr> <td class="imsum_left"><a href="#deactivatedInplace">deactivatedInplace</a></td> <td class="imsum_right">notifies container through the client that the object is deactivated. </td> </tr> <tr> <td class="imsum_left"><a href="#deactivatedUI">deactivatedUI</a></td> <td class="imsum_right">notifies container through the client that the object is UI-deactivated. </td> </tr> <tr> <td class="imsum_left"><a href="#getLayoutManager">getLayoutManager</a></td> <td class="imsum_right">allows to retrieve the ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/LayoutManager.html">LayoutManager</a> of the container. </td> </tr> <tr> <td class="imsum_left"><a href="#getInplaceDispatchProvider">getInplaceDispatchProvider</a></td> <td class="imsum_right">allows to retrieve the container's dispatch provider. </td> </tr> <tr> <td class="imsum_left"><a href="#getPlacement">getPlacement</a></td> <td class="imsum_right">gets the inplace object position rectangle. </td> </tr> <tr> <td class="imsum_left"><a href="#getClipRectangle">getClipRectangle</a></td> <td class="imsum_right">gets the inplace object clip rectangle. </td> </tr> <tr> <td class="imsum_left"><a href="#translateAccelerators">translateAccelerators</a></td> <td class="imsum_right">provides accelerator table the object whants to use while it is inplace active. </td> </tr> <tr> <td class="imsum_left"><a href="#scrollObject">scrollObject</a></td> <td class="imsum_right">scrolls the object. </td> </tr> <tr> <td class="imsum_left"><a href="#changedPlacement">changedPlacement</a></td> <td class="imsum_right">notifies the container that the position of the object is changed. </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="canInplaceActivate" class="membertitle">canInplaceActivate</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>canInplaceActivate</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>checks if the container can activate the object inplace. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> the container can activate the object inplace. <b>false</b> otherwise. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="activatingInplace" class="membertitle">activatingInplace</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>activatingInplace</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>notifies container through the client that the object is to be inplace activated. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the container is not ready for activation </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="activatingUI" class="membertitle">activatingUI</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>activatingUI</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>notifies container through the client that the object is to be UI-activated. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the container is not ready for activation </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="deactivatedInplace" class="membertitle">deactivatedInplace</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>deactivatedInplace</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>notifies container through the client that the object is deactivated. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the container is not ready for deactivation </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="deactivatedUI" class="membertitle">deactivatedUI</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>deactivatedUI</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>notifies container through the client that the object is UI-deactivated. </dd> <dd><p> After this notification the container can restore it's own UI and take focus. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the container is not ready for deactivation </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLayoutManager" class="membertitle">getLayoutManager</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="../frame/module-ix.html">frame</a>::<a href="../frame/XLayoutManager.html">XLayoutManager</a></td> </tr> <tr> <td valign="top"><b>getLayoutManager</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>allows to retrieve the ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/LayoutManager.html">LayoutManager</a> of the container. </dd> <dt><b>Returns</b></dt> <dd>reference to object representing the ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/LayoutManager.html">LayoutManager</a> of the container </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the object is in unexpected state to make such request </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getInplaceDispatchProvider" class="membertitle">getInplaceDispatchProvider</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="../frame/module-ix.html">frame</a>::<a href="../frame/XDispatchProvider.html">XDispatchProvider</a></td> </tr> <tr> <td valign="top"><b>getInplaceDispatchProvider</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>allows to retrieve the container's dispatch provider. </dd> <dt><b>Returns</b></dt> <dd>reference to object implementing the ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XDispatchProvider.html">XDispatchProvider</a> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the object is in unexpected state to make such request </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getPlacement" class="membertitle">getPlacement</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="../awt/module-ix.html">awt</a>::<a href="../awt/Rectangle.html">Rectangle</a></td> </tr> <tr> <td valign="top"><b>getPlacement</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets the inplace object position rectangle. </dd> <dd><p> The rectangle is provided in object's parent window coordinates in pixels. The intersection of position and clip rectangles specifies the visible part of the object. In case the position window has a size that is bigger than object's size, the object should either scale or deactivate. </p> </dd> <dt><b>Returns</b></dt> <dd>specifies a new position rectangle </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the object is in unexpected state to make such request </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getClipRectangle" class="membertitle">getClipRectangle</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="../awt/module-ix.html">awt</a>::<a href="../awt/Rectangle.html">Rectangle</a></td> </tr> <tr> <td valign="top"><b>getClipRectangle</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets the inplace object clip rectangle. </dd> <dd><p> The rectangle is provided in object's parent window coordinates in pixels. The intersection of position and clip rectangles specifies the visible part of the object. </p> </dd> <dt><b>Returns</b></dt> <dd>specifies a new clip rectangle </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the object is in unexpected state to make such request </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="translateAccelerators" class="membertitle">translateAccelerators</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>translateAccelerators</b>(</td> <td valign="top">[in] sequence< ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/KeyEvent.html">KeyEvent</a> ></td> <td valign="bottom"> aKeys )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides accelerator table the object whants to use while it is inplace active. </dd> <dt><b>Parameter aKeys</b></dt> <dd>an accelerator table from object </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the object is in unexpected state </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="scrollObject" class="membertitle">scrollObject</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>scrollObject</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Size.html">Size</a></td> <td valign="bottom"> aOffset )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>scrolls the object. </dd> <dt><b>Parameter aOffset</b></dt> <dd>scrolls the object to specified offset in pixels </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the object is in unexpected state </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="changedPlacement" class="membertitle">changedPlacement</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>changedPlacement</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Rectangle.html">Rectangle</a></td> <td valign="bottom"> aPosRect )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>notifies the container that the position of the object is changed. </dd> <dt><b>Parameter aPosRect</b></dt> <dd>specifies a new position rectangle </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the object state is not correct </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::uno::Exception in case of other problems </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
>
3011
