annotate dwt/dnd/DropTargetEvent.d @ 259:c0d810de7093

Update SWT 3.4M7 to 3.4
author Frank Benoit <benoit@tionex.de>
date Sun, 29 Jun 2008 14:33:38 +0200
parents 0f12f6bb9739
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
108
0f12f6bb9739 author notice
Frank Benoit <benoit@tionex.de>
parents: 92
diff changeset
1 /*******************************************************************************
259
c0d810de7093 Update SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 108
diff changeset
2 * Copyright (c) 2000, 2008 IBM Corporation and others.
92
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
108
0f12f6bb9739 author notice
Frank Benoit <benoit@tionex.de>
parents: 92
diff changeset
10 * Port to the D programming language:
0f12f6bb9739 author notice
Frank Benoit <benoit@tionex.de>
parents: 92
diff changeset
11 * Frank Benoit <benoit@tionex.de>
92
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwt.dnd.DropTargetEvent;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 import dwt.events.TypedEvent;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 import dwt.widgets.Widget;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 import dwt.dnd.TransferData;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 import dwt.dnd.DNDEvent;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 import dwt.widgets.Event;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 /**
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * The DropTargetEvent contains the event information passed in the methods of the DropTargetListener.
259
c0d810de7093 Update SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 108
diff changeset
24 *
c0d810de7093 Update SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 108
diff changeset
25 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
92
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 */
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 public class DropTargetEvent : TypedEvent {
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 /**
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * The x-cordinate of the cursor relative to the <code>Display</code>
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 */
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 public int x;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 /**
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * The y-cordinate of the cursor relative to the <code>Display</code>
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 */
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 public int y;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 /**
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * The operation being performed.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * @see DND#DROP_NONE
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * @see DND#DROP_MOVE
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 * @see DND#DROP_COPY
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 * @see DND#DROP_LINK
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 */
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 public int detail;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 /**
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 * A bitwise OR'ing of the operations that the DragSource can support
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 * (e.g. DND.DROP_MOVE | DND.DROP_COPY | DND.DROP_LINK).
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * The detail value must be a member of this list or DND.DROP_NONE.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 * @see DND#DROP_NONE
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * @see DND#DROP_MOVE
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 * @see DND#DROP_COPY
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 * @see DND#DROP_LINK
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 */
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 public int operations;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 /**
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 * A bitwise OR'ing of the drag under effect feedback to be displayed to the user
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 * (e.g. DND.FEEDBACK_SELECT | DND.FEEDBACK_SCROLL | DND.FEEDBACK_EXPAND).
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 * <p>A value of DND.FEEDBACK_NONE indicates that no drag under effect will be displayed.</p>
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 * <p>Feedback effects will only be applied if they are applicable.</p>
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 * <p>The default value is DND.FEEDBACK_SELECT.</p>
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 * @see DND#FEEDBACK_NONE
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 * @see DND#FEEDBACK_SELECT
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 * @see DND#FEEDBACK_INSERT_BEFORE
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 * @see DND#FEEDBACK_INSERT_AFTER
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 * @see DND#FEEDBACK_SCROLL
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * @see DND#FEEDBACK_EXPAND
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 */
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 public int feedback;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 /**
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 * If the associated control is a table or tree, this field contains the item located
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 * at the cursor coordinates.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 */
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 public Widget item;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 /**
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 * The type of data that will be dropped.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 */
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 public TransferData currentDataType;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 /**
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 * A list of the types of data that the DragSource is capable of providing.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 * The currentDataType must be a member of this list.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 */
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 public TransferData[] dataTypes;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 static const long serialVersionUID = 3256727264573338678L;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 /**
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 * Constructs a new instance of this class based on the
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 * information in the given untyped event.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 *
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 * @param e the untyped event containing the information
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 */
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 public this(DNDEvent e) {
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 super(cast(Event)e);
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 this.data = e.data;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 this.x = e.x;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 this.y = e.y;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 this.detail = e.detail;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 this.currentDataType = e.dataType;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 this.dataTypes = e.dataTypes;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 this.operations = e.operations;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 this.feedback = e.feedback;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 this.item = e.item;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109 }
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110 void updateEvent(DNDEvent e) {
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111 e.widget = this.widget;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112 e.time = this.time;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113 e.data = this.data;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
114 e.x = this.x;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
115 e.y = this.y;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
116 e.detail = this.detail;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
117 e.dataType = this.currentDataType;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
118 e.dataTypes = this.dataTypes;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
119 e.operations = this.operations;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
120 e.feedback = this.feedback;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
121 e.item = this.item;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
122 }
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
123 }