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