AOO410/main/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.idl

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/



#ifndef __com_sun_star_datatransfer_dnd_DropTargetDragEvent_idl__
#define __com_sun_star_datatransfer_dnd_DropTargetDragEvent_idl__

#ifndef __com_sun_star_datatransfer_dnd_DropTargetEvent_idl__
#include <com/sun/star/datatransfer/dnd/DropTargetEvent.idl>
#endif

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

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

 published interface XDropTargetDragContext;

//=============================================================================
/** The <type>DropTargetDragEvent</type> is delivered from the drop target 
	to the currently registered drop target listener. 

	<p>It contains information regarding the current state of the operation to enable
	the operations initiator to provide the end user with the appropriate drag 
	over feedback.</p>

	@see com::sun::star::datatransfer::dnd::XDropTargetListener
*/

published struct DropTargetDragEvent: com::sun::star::datatransfer::dnd::DropTargetEvent
{
	//-------------------------------------------------------------------------
	/** The drop target context of the current drag operation.

		@see com::sun::star::datatransfer::dnd::XDropTargetDragContext
	 */

	XDropTargetDragContext Context;
	
	//-------------------------------------------------------------------------
	/** This value represents the currently selected drop action.
		
		@see com::sun::star::datatransfer::dnd::DNDConstants
	 */

	byte DropAction;
	
	//-------------------------------------------------------------------------
	/** The cursor's current x location within the window's coordinates.
	 */

	long LocationX;

	//-------------------------------------------------------------------------
	/** The cursor's current y location within the window's coordinates.
	 */

	long LocationY;

	//-------------------------------------------------------------------------
	/** This value represents the action or actions supported by the source.
		This may be a combination of arbitrary source actions except ACTION_DEFAULT.
		<p>To combine different actions use a logical OR.</p>
		
		@see com::sun::star::datatransfer::dnd::DNDConstants
	 */

	byte SourceActions;
};

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

}; }; }; }; };

#endif