annotate dwt/events/SelectionListener.d @ 253:fbb9174f2a2c

Reuse the tango windows api
author Frank Benoit <benoit@tionex.de>
date Fri, 11 Jul 2008 23:01:25 +0200
parents bef1ed4ebc50
children 02332a154347
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
1 /*******************************************************************************
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
2 * Copyright (c) 2000, 2005 IBM Corporation and others.
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
5 * which accompanies this distribution, and is available at
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
7 *
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
8 * Contributors:
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
10 * Port to the D programming language:
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
11 * Frank Benoit <benoit@tionex.de>
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
12 *******************************************************************************/
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
13 module dwt.events.SelectionListener;
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
14
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
15
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
16 public import dwt.internal.DWTEventListener;
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
17 public import dwt.events.SelectionEvent;
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
18
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
19 /**
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
20 * Classes which implement this interface provide methods
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
21 * that deal with the events that are generated when selection
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
22 * occurs in a control.
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
23 * <p>
86
bef1ed4ebc50 again copied events from dwt-linux
Frank Benoit <benoit@tionex.de>
parents: 0
diff changeset
24 * After creating an instance of a class that :
0
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
25 * this interface it can be added to a control using the
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
26 * <code>addSelectionListener</code> method and removed using
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
27 * the <code>removeSelectionListener</code> method. When
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
28 * selection occurs in a control the appropriate method
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
29 * will be invoked.
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
30 * </p>
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
31 *
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
32 * @see SelectionAdapter
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
33 * @see SelectionEvent
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
34 */
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
35 public interface SelectionListener : DWTEventListener {
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
36
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
37 /**
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
38 * Sent when selection occurs in the control.
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
39 * <p>
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
40 * For example, selection occurs in a List when the user selects
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
41 * an item or items with the keyboard or mouse. On some platforms,
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
42 * the event occurs when a mouse button or key is pressed. On others,
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
43 * it happens when the mouse or key is released. The exact key or
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
44 * mouse gesture that causes this event is platform specific.
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
45 * </p>
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
46 *
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
47 * @param e an event containing information about the selection
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
48 */
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
49 public void widgetSelected(SelectionEvent e);
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
50
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
51 /**
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
52 * Sent when default selection occurs in the control.
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
53 * <p>
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
54 * For example, on some platforms default selection occurs in a List
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
55 * when the user double-clicks an item or types return in a Text.
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
56 * On some platforms, the event occurs when a mouse button or key is
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
57 * pressed. On others, it happens when the mouse or key is released.
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
58 * The exact key or mouse gesture that causes this event is platform
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
59 * specific.
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
60 * </p>
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
61 *
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
62 * @param e an event containing information about the default selection
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
63 */
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
64 public void widgetDefaultSelected(SelectionEvent e);
5406a8f6526d Add initial files
John Reimer <terminal.node@gmail.com
parents:
diff changeset
65 }
253
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
66
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
67
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
68
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
69 /// Helper class for the dgListener template function
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
70 private class _DgSelectionListenerWidgetSelectedT(Dg,T...) : SelectionListener {
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
71
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
72 alias ParameterTupleOf!(DgSel) DgArgs;
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
73 static assert( is(DgArgs == Tuple!(SelectionEvent,T)),
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
74 "Delegate args not correct" );
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
75
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
76 Dg dg;
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
77 T t;
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
78
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
79 private this( Dg dg, T t ){
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
80 this.dg = dg;
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
81 static if( T.length > 0 ){
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
82 this.t = t;
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
83 }
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
84 }
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
85
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
86 public void widgetSelected(SelectionEvent e){
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
87 dg(e,t);
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
88 }
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
89 public void widgetDefaultSelected(SelectionEvent e){
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
90 }
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
91 }
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
92
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
93 private class _DgSelectionListenerWidgetDefaultSelectedT(Dg,T...) : SelectionListener {
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
94
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
95 alias ParameterTupleOf!(DgSel) DgArgs;
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
96 static assert( is(DgArgs == Tuple!(SelectionEvent,T)),
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
97 "Delegate args not correct" );
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
98
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
99 Dg dg;
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
100 T t;
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
101
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
102 private this( Dg dg, T t ){
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
103 this.dg = dg;
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
104 static if( T.length > 0 ){
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
105 this.t = t;
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
106 }
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
107 }
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
108
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
109 public void widgetSelected(SelectionEvent e){
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
110 }
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
111 public void widgetDefaultSelected(SelectionEvent e){
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
112 dg(e,t);
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
113 }
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
114 }
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
115
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
116 SelectionListener dgSelectionListenerWidgetSelected( Dg, T... )( Dg dg, T args ){
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
117 return new _DgSelectionListenerWidgetSelectedT!( Dg, T )( dg, args );
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
118 }
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
119 SelectionListener dgSelectionListenerWidgetDefaultSelected( Dg, T... )( Dg dg, T args ){
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
120 return new _DgSelectionListenerWidgetDefaultSelectedT!( Dg, T )( dg, args );
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
121 }
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
122
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
123
fbb9174f2a2c Reuse the tango windows api
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
124