Sophie

Sophie

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

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

<html>
<head>
<title>Interface XAutoscroll</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="XAutoscroll-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">datatransfer</a> :: <a href="module-ix.html" class="namechain">dnd</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XAutoscroll</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Interface for autoscroll support.

 </dd>
<dd><p>During Drag and Drop operations it is possible that a user may wish to drop the 
 subject of the operation on a region of a scrollable GUI control that is
 not currently visible to the user.</p> 

 <p>In such situations it is desirable that the GUI control detect this and
 institute a scroll operation in order to make obscured region(s) visible to
 the user. This feature is known as autoscrolling.</p>

 <p>If a GUI control is both an active DropTarget and is also scrollable, 
 it can receive notifications of autoscrolling gestures by the user from
 the Drag and Drop system by implementing this interface.</p>

 <p>An autoscrolling gesture is initiated by the user by keeping the drag 
 cursor motionless with a border region of the Component, referred to as
 the "autoscrolling region", for a predefined period of time, this will
 result in repeated scroll requests to the Component until the drag Cursor
 resumes its motion. </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="#autoscroll">autoscroll</a></td>
<td class="imsum_right">Notify the component to autoscroll.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getAutoscrollRegion">getAutoscrollRegion</a></td>
<td class="imsum_right">Returns the regions describing the autoscrolling region.

 &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="autoscroll" class="membertitle">autoscroll</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>autoscroll</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;cursorLocationX,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;cursorLocationY );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Notify the component to autoscroll.

 </dd>
<dt><b>Parameter cursorLocationX</b></dt>
<dd>X location of the cursor in pixel.

 </dd>
<dt><b>Parameter cursorLocationY</b></dt>
<dd>Y location of the cursor in pixel.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getAutoscrollRegion" class="membertitle">getAutoscrollRegion</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">any</td>
</tr>
<tr>
<td valign="top"><b>getAutoscrollRegion</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns the regions describing the autoscrolling region.

 </dd>
<dt><b>Returns</b></dt>
<dd>The regions describing the autoscrolling region or border 
 relative to the geometry of the implementing component.
 </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>