annotate dwt/events/SelectionListener.d @ 315:21959e16bc1e

Improved Listeners access functions.
author Frank Benoit <benoit@tionex.de>
date Tue, 16 Sep 2008 15:28:21 +0200
parents 5899e0b43e5d
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 /*******************************************************************************
2
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2005 IBM Corporation and others.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
b8884f396ec8 some listeners
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>
2
b8884f396ec8 some listeners
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.SelectionListener;
2
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
16 public import dwt.internal.DWTEventListener;
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
17 public import dwt.events.SelectionEvent;
2
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18
315
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
19 import tango.core.Traits;
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
20 import tango.core.Tuple;
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
21
2
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 /**
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * Classes which implement this interface provide methods
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * that deal with the events that are generated when selection
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * occurs in a control.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * <p>
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * After creating an instance of a class that :
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * this interface it can be added to a control using the
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * <code>addSelectionListener</code> method and removed using
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * the <code>removeSelectionListener</code> method. When
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * selection occurs in a control the appropriate method
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * will be invoked.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * </p>
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 *
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * @see SelectionAdapter
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * @see SelectionEvent
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 */
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
38 public interface SelectionListener : DWTEventListener {
2
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39
315
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
40 public enum {
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
41 SELECTION,
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
42 DEFAULTSELECTION
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
43 }
2
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 /**
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 * Sent when selection occurs in the control.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 * <p>
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 * For example, selection occurs in a List when the user selects
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 * an item or items with the keyboard or mouse. On some platforms,
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 * the event occurs when a mouse button or key is pressed. On others,
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * it happens when the mouse or key is released. The exact key or
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 * mouse gesture that causes this event is platform specific.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * </p>
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 *
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 * @param e an event containing information about the selection
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 */
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 public void widgetSelected(SelectionEvent e);
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 /**
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 * Sent when default selection occurs in the control.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 * <p>
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 * For example, on some platforms default selection occurs in a List
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 * when the user double-clicks an item or types return in a Text.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 * On some platforms, the event occurs when a mouse button or key is
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 * pressed. On others, it happens when the mouse or key is released.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 * The exact key or mouse gesture that causes this event is platform
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 * specific.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 * </p>
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 *
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * @param e an event containing information about the default selection
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 */
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 public void widgetDefaultSelected(SelectionEvent e);
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 }
315
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
73
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
74
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
75 /// DWT extension
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
76 private class _DgSelectionListenerT(Dg,T...) : SelectionListener {
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
77
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
78 alias ParameterTupleOf!(Dg) DgArgs;
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
79 static assert( is(DgArgs == Tuple!(SelectionEvent,T)),
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
80 "Delegate args not correct: "~DgArgs.stringof~" vs. (Event,"~T.stringof~")" );
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
81
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
82 Dg dg;
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
83 T t;
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
84 int type;
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
85
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
86 private this( int type, Dg dg, T t ){
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
87 this.type = type;
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
88 this.dg = dg;
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
89 static if( T.length > 0 ){
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
90 this.t = t;
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
91 }
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
92 }
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
93
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
94 public void widgetSelected(SelectionEvent e){
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
95 if( type is SelectionListener.SELECTION ){
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
96 dg(e,t);
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
97 }
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
98 }
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
99 public void widgetDefaultSelected(SelectionEvent e){
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
100 if( type is SelectionListener.DEFAULTSELECTION ){
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
101 dg(e,t);
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
102 }
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
103 }
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
104 }
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
105
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
106 SelectionListener dgSelectionListener( Dg, T... )( int type, Dg dg, T args ){
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
107 return new _DgSelectionListenerT!( Dg, T )( type, dg, args );
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
108 }
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
109
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
110 SelectionListener dgSelectionListenerWidgetSelected( Dg, T... )( Dg dg, T args ){
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
111 return dgSelectionListener( SelectionListener.SELECTION, dg, args );
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
112 }
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
113 SelectionListener dgSelectionListenerWidgetDefaultSelected( Dg, T... )( Dg dg, T args ){
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
114 return dgSelectionListener( SelectionListener.DEFAULTSELECTION, dg, args );
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
115 }
21959e16bc1e Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
116