offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_datatransfer_dnd_XAutoscroll_idl__
  21 #define __com_sun_star_datatransfer_dnd_XAutoscroll_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25
  26 module com { module sun { module star { module datatransfer { module dnd {
  27
  28 /** Interface for autoscroll support.
  29
  30     <p>During Drag and Drop operations it is possible that a user may wish to drop the
  31     subject of the operation on a region of a scrollable GUI control that is
  32     not currently visible to the user.</p>
  33
  34     <p>In such situations it is desirable that the GUI control detect this and
  35     institute a scroll operation in order to make obscured region(s) visible to
  36     the user. This feature is known as autoscrolling.</p>
  37
  38     <p>If a GUI control is both an active DropTarget and is also scrollable,
  39     it can receive notifications of autoscrolling gestures by the user from
  40     the Drag and Drop system by implementing this interface.</p>
  41
  42     <p>An autoscrolling gesture is initiated by the user by keeping the drag
  43     cursor motionless with a border region of the Component, referred to as
  44     the "autoscrolling region", for a predefined period of time, this will
  45     result in repeated scroll requests to the Component until the drag Cursor
  46     resumes its motion. </p>
  47 */
  48
  49 published interface XAutoscroll: com::sun::star::uno::XInterface
  50 {
  51     /** Notify the component to autoscroll.
  52
  53         @param cursorLocationX
  54         X location of the cursor in pixel.
  55
  56         @param cursorLocationY
  57         Y location of the cursor in pixel.
  58     */
  59
  60     void autoscroll( [in] long cursorLocationX, [in] long cursorLocationY );
  61
  62     /** Returns the regions describing the autoscrolling region.
  63
  64         @returns
  65         The regions describing the autoscrolling region or border
  66         relative to the geometry of the implementing component.
  67     */
  68
  69     any getAutoscrollRegion();
  70 };
  71
  72
  73 }; }; }; }; };
  74
  75 #endif
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */