xref: /trunk/main/offapi/com/sun/star/datatransfer/dnd/DropTargetDropEvent.idl (revision d1766043)

/**************************************************************
 *
 * 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_DropTargetDropEvent_idl__
#define __com_sun_star_datatransfer_dnd_DropTargetDropEvent_idl__

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

#ifndef __com_sun_star_datatransfer_XTransferable_idl__
#include <com/sun/star/datatransfer/XTransferable.idl>
#endif

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

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

 published interface XDropTargetDropContext;

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

	<p>It contains sufficient information for the originator of the operation to
	provide appropriate feedback to the end user when the operation completes.</p>
*/

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

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

	XDropTargetDropContext Context;

	//-------------------------------------------------------------------------
	/** This value represents the action or actions selected by the user at
		the time of the drop.

		<p>If more than one action is specified, the <type>XDropTargetListener</type>
		 should raise a dialog to ask the user which action to use.</p>

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

	byte DropAction;

	//-------------------------------------------------------------------------
	/** The cursor's current x location within the windows' coordinates.
	 */

	long LocationX;

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

	long LocationY;

	//-------------------------------------------------------------------------
	/** This value represents the action or actions supported by the source.
	 */

	byte SourceActions;

	//-------------------------------------------------------------------------
	/** The transferable object associated with the drop.

		@see com::sun::star::datatransfer::XTransferable
	 */

	com::sun::star::datatransfer::XTransferable Transferable;
};

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

}; }; }; }; };

#endif