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