xref: /AOO41X/main/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_datatransfer_dnd_DropTargetDragEvent_idl__
29#define __com_sun_star_datatransfer_dnd_DropTargetDragEvent_idl__
30
31#ifndef __com_sun_star_datatransfer_dnd_DropTargetEvent_idl__
32#include <com/sun/star/datatransfer/dnd/DropTargetEvent.idl>
33#endif
34
35//=============================================================================
36
37module com { module sun { module star { module datatransfer { module dnd {
38
39 published interface XDropTargetDragContext;
40
41//=============================================================================
42/** The <type>DropTargetDragEvent</type> is delivered from the drop target
43	to the currently registered drop target listener.
44
45	<p>It contains information regarding the current state of the operation to enable
46	the operations initiator to provide the end user with the appropriate drag
47	over feedback.</p>
48
49	@see com::sun::star::datatransfer::dnd::XDropTargetListener
50*/
51
52published struct DropTargetDragEvent: com::sun::star::datatransfer::dnd::DropTargetEvent
53{
54	//-------------------------------------------------------------------------
55	/** The drop target context of the current drag operation.
56
57		@see com::sun::star::datatransfer::dnd::XDropTargetDragContext
58	 */
59
60	XDropTargetDragContext Context;
61
62	//-------------------------------------------------------------------------
63	/** This value represents the currently selected drop action.
64
65		@see com::sun::star::datatransfer::dnd::DNDConstants
66	 */
67
68	byte DropAction;
69
70	//-------------------------------------------------------------------------
71	/** The cursor's current x location within the window's coordinates.
72	 */
73
74	long LocationX;
75
76	//-------------------------------------------------------------------------
77	/** The cursor's current y location within the window's coordinates.
78	 */
79
80	long LocationY;
81
82	//-------------------------------------------------------------------------
83	/** This value represents the action or actions supported by the source.
84		This may be a combination of arbitrary source actions except ACTION_DEFAULT.
85		<p>To combine different actions use a logical OR.</p>
86
87		@see com::sun::star::datatransfer::dnd::DNDConstants
88	 */
89
90	byte SourceActions;
91};
92
93//=============================================================================
94
95}; }; }; }; };
96
97#endif
98