Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 7731

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Interface XDockingAreaAcceptor</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="XDockingAreaAcceptor-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 XDockingAreaAcceptor</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>this interface enables developer to implement different docking area
 acceptors which are used by the frame based layout manager.

 </dd>
<dd><p>
 A docking area acceptor is responsible to control the docking area of a
 container window. As OLE for example supports inplace and outplace editing, 
 there are different parts of code responsible for the container window. 
 This interface enables developer to make support implementations for these 
 scenarios.

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</dd>
<dt><b>See also</b></dt>
<dd>::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XFrame.html">XFrame</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="#getContainerWindow">getContainerWindow</a></td>
<td class="imsum_right">provide the container window where the layout manager can request border 
 space for docking windows.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#requestDockingAreaSpace">requestDockingAreaSpace</a></td>
<td class="imsum_right">method to ask an implementation if the provided space for docking windows 
 is available or not.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setDockingAreaSpace">setDockingAreaSpace</a></td>
<td class="imsum_right">method to brief an implementation that we need new border space.

 &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="getContainerWindow" class="membertitle">getContainerWindow</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/XWindow.html">XWindow</a></td>
</tr>
<tr>
<td valign="top"><b>getContainerWindow</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>provide the container window where the layout manager can request border 
 space for docking windows.
 
 </dd>
<dd><p>
 Additionally the layout manager uses this window to create its own child 
 windows for docking purposes.
 </p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="requestDockingAreaSpace" class="membertitle">requestDockingAreaSpace</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>requestDockingAreaSpace</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">&nbsp;RequestedSpace );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>method to ask an implementation if the provided space for docking windows 
 is available or not.
 
 </dd>
<dd><p>
 The ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Rectangle.html">Rectangle</a> parameter is 
 filled by the caller with pixel data. The members of 
 ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Rectangle.html">Rectangle</a> must be filled 
 as following:
 <ul>
 <li>X = requested area on left side (in pixel)</li>
 <li>Y = requested area on top side (in pixel)</li>
 <li>Width = requested area on right side (in pixel)</li>
 <li>Height = requested area on bottom side (in pixel)</li>
 </ul>
 </p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setDockingAreaSpace" class="membertitle">setDockingAreaSpace</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>setDockingAreaSpace</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">&nbsp;BorderSpace );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>method to brief an implementation that we need new border space.

 </dd>
<dd><p>
 The callee must size its document window so that we have the amount 
 of space we have provided. The ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Rectangle.html">Rectangle</a>
 parameter is filled by the caller with pixel data. The members of 
 ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Rectangle.html">Rectangle</a> must be filled as 
 following:
 <ul>
 <li>X = new area on left side (in pixel)</li>
 <li>Y = new area on top side (in pixel)</li>
 <li>Width = new area on right side (in pixel)</li>
 <li>Height = new area on bottom side (in pixel)</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; 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>