annotate dwt/events/TraverseListener.d @ 364:2bcb17ebe0be default tip

fix: thx torhu
author Frank Benoit <benoit@tionex.de>
date Sun, 08 Nov 2009 20:57:46 +0100
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, 2003 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.TraverseListener;
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.TraverseEvent;
2
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 /**
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 * Classes which implement this interface provide a method
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * that deals with the events that are generated when a
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * traverse event occurs in a control.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * <p>
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * After creating an instance of a class that :
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * this interface it can be added to a control using the
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * <code>addTraverseListener</code> method and removed using
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * the <code>removeTraverseListener</code> method. When a
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * traverse event occurs in a control, the keyTraversed method
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * will be invoked.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * </p>
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 *
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * @see TraverseEvent
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 */
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
34 public interface TraverseListener : DWTEventListener {
2
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 /**
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * Sent when a traverse event occurs in a control.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * <p>
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * A traverse event occurs when the user presses a traversal
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * key. Traversal keys are typically tab and arrow keys, along
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * with certain other keys on some platforms. Traversal key
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 * constants beginning with <code>TRAVERSE_</code> are defined
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
43 * in the <code>DWT</code> class.
2
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 * </p>
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 *
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 * @param e an event containing information about the traverse
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 */
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 public void keyTraversed(TraverseEvent e);
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 }