Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: datatransfer :: dnd ::

interface XAutoscroll
Description
Interface for autoscroll support.

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.

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.

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.

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.


Methods' Summary
autoscroll Notify the component to autoscroll.  
getAutoscrollRegion Returns the regions describing the autoscrolling region.  
Methods' Details
autoscroll
[oneway] void
autoscroll( [in] long  cursorLocationX,
[in] long  cursorLocationY );

Description
Notify the component to autoscroll.
Parameter cursorLocationX
X location of the cursor in pixel.
Parameter cursorLocationY
Y location of the cursor in pixel.
getAutoscrollRegion
any
getAutoscrollRegion();

Description
Returns the regions describing the autoscrolling region.
Returns
The regions describing the autoscrolling region or border relative to the geometry of the implementing component.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.