update dev300-m58
[ooovba.git] / offapi / com / sun / star / datatransfer / dnd / XAutoscroll.idl
blobe9cd0457da39dde67b4af722ebfbdf79e7a5c3dd
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: XAutoscroll.idl,v $
10 * $Revision: 1.6 $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
31 #ifndef __com_sun_star_datatransfer_dnd_XAutoscroll_idl__
32 #define __com_sun_star_datatransfer_dnd_XAutoscroll_idl__
34 #ifndef __com_sun_star_uno_XInterface_idl__
35 #include <com/sun/star/uno/XInterface.idl>
36 #endif
38 //=============================================================================
40 module com { module sun { module star { module datatransfer { module dnd {
42 //=============================================================================
43 /** Interface for autoscroll support.
45 <p>During Drag and Drop operations it is possible that a user may wish to drop the
46 subject of the operation on a region of a scrollable GUI control that is
47 not currently visible to the user.</p>
49 <p>In such situations it is desirable that the GUI control detect this and
50 institute a scroll operation in order to make obscured region(s) visible to
51 the user. This feature is known as autoscrolling.</p>
53 <p>If a GUI control is both an active DropTarget and is also scrollable,
54 it can receive notifications of autoscrolling gestures by the user from
55 the Drag and Drop system by implementing this interface.</p>
57 <p>An autoscrolling gesture is initiated by the user by keeping the drag
58 cursor motionless with a border region of the Component, referred to as
59 the "autoscrolling region", for a predefined period of time, this will
60 result in repeated scroll requests to the Component until the drag Cursor
61 resumes its motion. </p>
64 published interface XAutoscroll: com::sun::star::uno::XInterface
66 //-------------------------------------------------------------------------
67 /** Notify the component to autoscroll.
69 @param cursorLocationX
70 X location of the cursor in pixel.
72 @param cursorLocationY
73 Y location of the cursor in pixel.
76 [oneway] void autoscroll( [in] long cursorLocationX, [in] long cursorLocationY );
78 //-------------------------------------------------------------------------
79 /** Returns the regions describing the autoscrolling region.
81 @returns
82 The regions describing the autoscrolling region or border
83 relative to the geometry of the implementing component.
86 any getAutoscrollRegion();
89 //=============================================================================
91 }; }; }; }; };
93 #endif