annotate dwt/events/TypedEvent.d @ 238:380bad9f6852

reverted char[] to String
author Frank Benoit <benoit@tionex.de>
date Mon, 05 May 2008 00:42:55 +0200
parents f2e04420fd6c
children c0d810de7093
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 /*******************************************************************************
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
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.TypedEvent;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
238
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 150
diff changeset
15 import dwt.dwthelper.utils;
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 150
diff changeset
16
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
18 import dwt.widgets.Event;
26
09f5459a5014 Display in work
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
19 import dwt.widgets.Display;
09f5459a5014 Display in work
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
20 import dwt.widgets.Widget;
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
21 import dwt.internal.DWTEventObject;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 import tango.text.convert.Format;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 import tango.text.Util : split;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * This is the super class for all typed event classes provided
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
28 * by DWT. Typed events contain particular information which is
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * applicable to the event occurrence.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 *
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
31 * @see dwt.widgets.Event
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 */
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
33 public class TypedEvent : DWTEventObject {
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
35 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
36 * the display where the event occurred
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
37 *
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
38 * @since 2.0
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
39 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
40 public Display display;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
42 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
43 * the widget that issued the event
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
44 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
45 public Widget widget;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
47 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
48 * the time that the event occurred.
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
49 *
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
50 * NOTE: This field is an unsigned integer and should
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
51 * be AND'ed with 0xFFFFFFFFL so that it can be treated
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
52 * as a signed long.
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
53 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
54 public int time;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
56 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
57 * a field for application use
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
58 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
59 public Object data;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
61 //static final long serialVersionUID = 3257285846578377524L;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 * Constructs a new instance of this class.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 * @param object the object that fired the event
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 public this(Object object) {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
69 super(object);
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 }
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 * Constructs a new instance of this class based on the
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 * information in the argument.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 * @param e the low level event to initialize the receiver with
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 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: 26
diff changeset
79 super(e.widget);
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
80 this.display = e.display;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
81 this.widget = e.widget;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
82 this.time = e.time;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 26
diff changeset
83 this.data = e.data;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 }
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 * Returns the name of the event. This is the name of
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 * the class without the module name.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 * @return the name of the event
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 */
238
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 150
diff changeset
92 String getName () {
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 150
diff changeset
93 String str = this.classinfo.name;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 return split( str, "." )[$-1];
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 }
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 * Returns a string containing a concise, human-readable
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 * description of the receiver.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 * @return a string representation of the event
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 */
238
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 150
diff changeset
103 public override String toString() {
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 150
diff changeset
104 String str_widget = widget is null ? "null" : widget.toString;
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 150
diff changeset
105 String str_data = data is null ? "null" : data.toString;
143
6cd44e0b522d activating the listeners
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
106 return Format( "{}{{time={} data={}}", str_widget, time, str_data );
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 }
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 }