/*************************************************************************
 *
 *  $RCSfile: XDragSourceContext.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: mi $ $Date: 2002/10/03 13:03:35 $
 *
 *  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_XDragSourceContext_idl__
#define __com_sun_star_datatransfer_dnd_XDragSourceContext_idl__

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

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

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

interface XDragSourceListener;

//=============================================================================
/** The drag source context class is responsible for managing the initiator side 
	of the Drag and Drop protocol. 

	<p>In particular, it is responsible for managing event notifications to the 
	DragSourceListener and providing the Transferable state to enable the data 
	transfer. </p>

	<p>An instance of this class is created as a result of the method <member>XDragSource::startDrag()</member>
	being successfully invoked. This instance is responsible 
	for tracking the state of the operation on behalf of the drag source and 
	dispatching state changes to the drag source listener. </p>

	@see com::sun::star::datatransfer::dnd::XDragSourceContext
	@see com::sun::star::datatransfer::dnd::XDragSourceListener
*/

interface XDragSourceContext: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/** Get the identifier of the currently used cursor.

		@returns 
		The currently selected drag cursor.
	*/
	
	long getCurrentCursor();

	//-------------------------------------------------------------------------
	/** This method sets the current drag cursor.

		<p>This method should only be called to set another cursor than the
		default one for drag action currently selected by the user.</p>
		<p>Invalid cursor identifiers will be ignored.</p>

		@param cursorId
		The identifier the drag source returned when registering the cursor. 
	*/
	
	[oneway] void setCursor( [in] long cursorId );

	//-------------------------------------------------------------------------
	/** This method sets the current drag image. 

		@param dragImage
		The identifier the drag source returned when registering the image (0 = none).
		Invalid identifier will be ignored.
	*/
	
	[oneway] void setImage( [in] long imageId );

	//-------------------------------------------------------------------------
	/** This method notifies the context that the 
		<type scope="com::sun::star::datatransfer">DataFlavor</type> types 
		of the transferable object have changed.
		
		@see com::sun::star::datatransfer::XTransferable	
	*/
	
	[oneway] void transferablesFlavorsChanged();
};

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

}; }; }; }; };

#endif
