annotate dwt/widgets/Listener.d @ 156:969e7de37c3d default tip

Fixes to get dwt to work with dmd and ldc
author Jacob Carlborg <doob@me.com>
date Wed, 08 Jul 2009 21:56:44 +0200
parents 38807a925e24
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
1 /*******************************************************************************
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
2 * Copyright (c) 2000, 2005 IBM Corporation and others.
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
7 *
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
8 * Contributors:
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
15
2952d5604c0a Ported some widgets, added some stuff to the runtime bindings
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents: 0
diff changeset
10 *
2952d5604c0a Ported some widgets, added some stuff to the runtime bindings
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents: 0
diff changeset
11 * Port to the D programming language:
45
d8635bb48c7c Merge with SWT 3.5
Jacob Carlborg <doob@me.com>
parents: 15
diff changeset
12 * Jacob Carlborg <doob@me.com>
126
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
13 * Frank Benoit <benoit@tionex.de>
0
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
14 *******************************************************************************/
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
15 module dwt.widgets.Listener;
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
16
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
17
15
2952d5604c0a Ported some widgets, added some stuff to the runtime bindings
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents: 0
diff changeset
18 import dwt.widgets.Event;
0
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
19
126
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
20 import tango.core.Traits;
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
21 import tango.core.Tuple;
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
22
0
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
23 /**
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
24 * Implementers of <code>Listener</code> provide a simple
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
25 * <code>handleEvent()</code> method that is used internally
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
26 * by DWT to dispatch events.
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
27 * <p>
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
28 * After creating an instance of a class that implements this interface
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
29 * it can be added to a widget using the
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
30 * <code>addListener(int eventType, Listener handler)</code> method and
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
31 * removed using the
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
32 * <code>removeListener (int eventType, Listener handler)</code> method.
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
33 * When the specified event occurs, <code>handleEvent(...)</code> will
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
34 * be sent to the instance.
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
35 * </p>
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
36 * <p>
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
37 * Classes which implement this interface are described within DWT as
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
38 * providing the <em>untyped listener</em> API. Typically, widgets will
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
39 * also provide a higher-level <em>typed listener</em> API, that is based
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
40 * on the standard <code>java.util.EventListener</code> pattern.
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
41 * </p>
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
42 * <p>
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
43 * Note that, since all internal DWT event dispatching is based on untyped
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
44 * listeners, it is simple to build subsets of DWT for use on memory
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
45 * constrained, small footprint devices, by removing the classes and
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
46 * methods which implement the typed listener API.
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
47 * </p>
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
48 *
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
49 * @see Widget#addListener
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
50 * @see java.util.EventListener
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
51 * @see dwt.events
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
52 */
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
53 public interface Listener {
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
54
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
55 /**
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
56 * Sent when an event that the receiver has registered for occurs.
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
57 *
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
58 * @param event the event which occurred
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
59 */
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
60 void handleEvent (Event event);
380af2bdd8e5 Upload of whole dwt tree
Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com>
parents:
diff changeset
61 }
126
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
62
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
63 /// Helper class for the dgListener template function
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
64 private class _DgListenerT(Dg,T...) : Listener {
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
65
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
66 alias ParameterTupleOf!(Dg) DgArgs;
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
67 static assert( is(DgArgs == Tuple!(Event,T)),
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
68 "Delegate args not correct: delegate args: ("~DgArgs.stringof~") vs. passed args: ("~Tuple!(Event,T).stringof~")" );
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
69
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
70 Dg dg;
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
71 T t;
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
72
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
73 private this( Dg dg, T t ){
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
74 this.dg = dg;
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
75 static if( T.length > 0 ){
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
76 this.t = t;
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
77 }
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
78 }
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
79
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
80 void handleEvent( Event e ){
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
81 dg(e,t);
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
82 }
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
83 }
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
84
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
85 /++
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
86 + dgListener creates a class implementing the Listener interface and delegating the call to
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
87 + handleEvent to the users delegate. This template function will store also additional parameters.
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
88 +
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
89 + Examle of usage:
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
90 + ---
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
91 + void handleTextEvent (Event e, int inset ) {
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
92 + // ...
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
93 + }
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
94 + text.addListener (DWT.FocusOut, dgListener( &handleTextEvent, inset ));
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
95 + ---
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
96 +/
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
97 Listener dgListener( Dg, T... )( Dg dg, T args ){
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
98 return new _DgListenerT!( Dg, T )( dg, args );
38807a925e24 Fixed compile errors, support for SWT language files
Jacob Carlborg <doob@me.com>
parents: 45
diff changeset
99 }