annotate dwt/events/MouseEvent.d @ 10:63c023465156

moved from org.eclipse.swt to dwt
author Frank Benoit <benoit@tionex.de>
date Sat, 05 Jan 2008 17:58:37 +0100
parents ad2b69216039
children 8cec8f536af3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2007 IBM Corporation and others.
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
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 *******************************************************************************/
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
11 module dwt.events.MouseEvent;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
14 import dwt.widgets.Event;
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
15 import dwt.events.TypedEvent;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 import tango.text.convert.Format;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 * Instances of this class are sent whenever mouse
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * related actions occur. This includes mouse buttons
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * being pressed and released, the mouse pointer being
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * moved and the mouse pointer crossing widget boundaries.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * <p>
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * Note: The <code>button</code> field is an integer that
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * represents the mouse button number. This is not the same
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * as the <code>SWT</code> mask constants <code>BUTTONx</code>.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * </p>
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * @see MouseListener
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * @see MouseMoveListener
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * @see MouseTrackListener
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 public class MouseEvent : TypedEvent {
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * the button that was pressed or released; 1 for the
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * first button, 2 for the second button, and 3 for the
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * third button, etc.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 public int button;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 * the state of the keyboard modifier keys at the time
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 * the event was generated
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 public int stateMask;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 * the widget-relative, x coordinate of the pointer
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * at the time the mouse button was pressed or released
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 public int x;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 * the widget-relative, y coordinate of the pointer
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 * at the time the mouse button was pressed or released
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 public int y;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 * the number times the mouse has been clicked, as defined
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 * by the operating system; 1 for the first click, 2 for the
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 * second click and so on.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 * @since 3.3
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 public int count;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 //static final long serialVersionUID = 3257288037011566898L;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 * Constructs a new instance of this class based on the
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 * information in the given untyped event.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 * @param e the untyped event containing the information
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 public this(Event e) {
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 super(e);
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 this.x = e.x;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 this.y = e.y;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 this.button = e.button;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 this.stateMask = e.stateMask;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 this.count = e.count;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 }
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 * Returns a string containing a concise, human-readable
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 * description of the receiver.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 * @return a string representation of the event
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 public char[] toString() {
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 return Format( "{} button={} stateMask={} x={} y={} count={}}",
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 super.toString[ 0 .. $-2 ],
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 button, stateMask, x, y, count );
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 }
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 }