annotate dwt/events/MouseEvent.d @ 317:6f57d3b9947c

sync with dwt-win
author Frank Benoit <benoit@tionex.de>
date Tue, 16 Sep 2008 15:28:56 +0200
parents c0d810de7093
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
72
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 71
diff changeset
1 /*******************************************************************************
259
c0d810de7093 Update SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 238
diff changeset
2 * Copyright (c) 2000, 2008 IBM Corporation and others.
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
72
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 71
diff changeset
10 * Port to the D programming language:
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 71
diff changeset
11 * Frank Benoit <benoit@tionex.de>
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
13 module dwt.events.MouseEvent;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
16 import dwt.widgets.Event;
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
17 import dwt.events.TypedEvent;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 import tango.text.convert.Format;
317
6f57d3b9947c sync with dwt-win
Frank Benoit <benoit@tionex.de>
parents: 259
diff changeset
20 import dwt.dwthelper.utils;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * Instances of this class are sent whenever mouse
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * related actions occur. This includes mouse buttons
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * being pressed and released, the mouse pointer being
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * moved and the mouse pointer crossing widget boundaries.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * <p>
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * Note: The <code>button</code> field is an integer that
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * represents the mouse button number. This is not the same
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
30 * as the <code>DWT</code> mask constants <code>BUTTONx</code>.
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * </p>
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * @see MouseListener
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * @see MouseMoveListener
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * @see MouseTrackListener
259
c0d810de7093 Update SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 238
diff changeset
36 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 public class MouseEvent : TypedEvent {
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
41 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
42 * the button that was pressed or released; 1 for the
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
43 * first button, 2 for the second button, and 3 for the
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
44 * third button, etc.
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
45 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
46 public int button;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
48 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
49 * the state of the keyboard modifier keys at the time
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
50 * the event was generated
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
51 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
52 public int stateMask;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
54 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
55 * the widget-relative, x coordinate of the pointer
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
56 * at the time the mouse button was pressed or released
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
57 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
58 public int x;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
60 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
61 * the widget-relative, y coordinate of the pointer
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
62 * at the time the mouse button was pressed or released
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
63 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
64 public int y;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
66 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
67 * the number times the mouse has been clicked, as defined
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
68 * by the operating system; 1 for the first click, 2 for the
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
69 * second click and so on.
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
70 *
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
71 * @since 3.3
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
72 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
73 public int count;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
75 //static final long serialVersionUID = 3257288037011566898L;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 * Constructs a new instance of this class based on the
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 * information in the given untyped event.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 * @param e the untyped event containing the information
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 public this(Event e) {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
84 super(e);
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
85 this.x = e.x;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
86 this.y = e.y;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
87 this.button = e.button;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
88 this.stateMask = e.stateMask;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
89 this.count = e.count;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 }
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 * Returns a string containing a concise, human-readable
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 * description of the receiver.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 * @return a string representation of the event
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 */
238
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 150
diff changeset
98 public override String toString() {
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 return Format( "{} button={} stateMask={} x={} y={} count={}}",
144
424cc4e14124 some notes with todos and author notice
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
100 super.toString[ 0 .. $-1 ],
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 button, stateMask, x, y, count );
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 }
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 }