/*************************************************************************
 *
 *  $RCSfile: XAutoscroll.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: mi $ $Date: 2002/10/03 13:03:34 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#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>
*/

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
