/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_datatransfer_dnd_XAutoscroll_idl__
#define __com_sun_star_datatransfer_dnd_XAutoscroll_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

//=============================================================================

module com { module sun { module star { module datatransfer { module dnd {

//=============================================================================
/** Interface for autoscroll support.

    <p>During Drag and Drop operations it is possible that a user may wish to drop the 
    subject of the operation on a region of a scrollable GUI control that is
    not currently visible to the user.</p>	

    <p>In such situations it is desirable that the GUI control detect this and
    institute a scroll operation in order to make obscured region(s) visible to
    the user. This feature is known as autoscrolling.</p>

    <p>If a GUI control is both an active DropTarget and is also scrollable, 
    it can receive notifications of autoscrolling gestures by the user from
    the Drag and Drop system by implementing this interface.</p>

    <p>An autoscrolling gesture is initiated by the user by keeping the drag 
    cursor motionless with a border region of the Component, referred to as
    the "autoscrolling region", for a predefined period of time, this will
    result in repeated scroll requests to the Component until the drag Cursor
    resumes its motion. </p>
*/

published interface XAutoscroll: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** Notify the component to autoscroll.

        @param cursorLocationX
        X location of the cursor in pixel.

        @param cursorLocationY
        Y location of the cursor in pixel.
    */
    
    [oneway] void autoscroll( [in] long cursorLocationX, [in] long cursorLocationY );
    
    //-------------------------------------------------------------------------
    /** Returns the regions describing the autoscrolling region.

        @returns 
        The regions describing the autoscrolling region or border 
        relative to the geometry of the implementing component.
    */
    
    any getAutoscrollRegion(); 
};

//=============================================================================

}; }; }; }; };

#endif
