annotate dwt/events/TraverseListener.d @ 10:63c023465156

moved from org.eclipse.swt to dwt
author Frank Benoit <benoit@tionex.de>
date Sat, 05 Jan 2008 17:58:37 +0100
parents ad2b69216039
children 295b29fc7d13
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
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
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 *******************************************************************************/
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
11 module dwt.events.TraverseListener;
2
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
14 public import dwt.internal.SWTEventListener;
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
15 public import dwt.events.TraverseEvent;
2
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 /**
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 * Classes which implement this interface provide a method
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 * that deals with the events that are generated when a
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 * traverse event occurs in a control.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * <p>
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * After creating an instance of a class that :
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * this interface it can be added to a control using the
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * <code>addTraverseListener</code> method and removed using
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * the <code>removeTraverseListener</code> method. When a
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * traverse event occurs in a control, the keyTraversed method
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * will be invoked.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * </p>
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 *
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * @see TraverseEvent
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 */
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 public interface TraverseListener : SWTEventListener {
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 /**
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * Sent when a traverse event occurs in a control.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * <p>
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * A traverse event occurs when the user presses a traversal
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * key. Traversal keys are typically tab and arrow keys, along
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * with certain other keys on some platforms. Traversal key
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * constants beginning with <code>TRAVERSE_</code> are defined
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * in the <code>SWT</code> class.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 * </p>
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 *
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 * @param e an event containing information about the traverse
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 */
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 public void keyTraversed(TraverseEvent e);
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 }