1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_datatransfer_dnd_XAutoscroll_idl__
25#define __com_sun_star_datatransfer_dnd_XAutoscroll_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31//=============================================================================
32
33module com { module sun { module star { module datatransfer { module dnd {
34
35//=============================================================================
36/** Interface for autoscroll support.
37
38	<p>During Drag and Drop operations it is possible that a user may wish to drop the
39	subject of the operation on a region of a scrollable GUI control that is
40	not currently visible to the user.</p>
41
42	<p>In such situations it is desirable that the GUI control detect this and
43	institute a scroll operation in order to make obscured region(s) visible to
44	the user. This feature is known as autoscrolling.</p>
45
46	<p>If a GUI control is both an active DropTarget and is also scrollable,
47	it can receive notifications of autoscrolling gestures by the user from
48	the Drag and Drop system by implementing this interface.</p>
49
50	<p>An autoscrolling gesture is initiated by the user by keeping the drag
51	cursor motionless with a border region of the Component, referred to as
52	the "autoscrolling region", for a predefined period of time, this will
53	result in repeated scroll requests to the Component until the drag Cursor
54	resumes its motion. </p>
55*/
56
57published interface XAutoscroll: com::sun::star::uno::XInterface
58{
59	//-------------------------------------------------------------------------
60	/** Notify the component to autoscroll.
61
62		@param cursorLocationX
63		X location of the cursor in pixel.
64
65		@param cursorLocationY
66		Y location of the cursor in pixel.
67	*/
68
69	[oneway] void autoscroll( [in] long cursorLocationX, [in] long cursorLocationY );
70
71    //-------------------------------------------------------------------------
72	/** Returns the regions describing the autoscrolling region.
73
74		@returns
75		The regions describing the autoscrolling region or border
76		relative to the geometry of the implementing component.
77	*/
78
79	any getAutoscrollRegion();
80};
81
82//=============================================================================
83
84}; }; }; }; };
85
86#endif
87