01: /*******************************************************************************
02: * Copyright (c) 2000, 2003 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.swt.events;
11:
12: import org.eclipse.swt.internal.SWTEventListener;
13:
14: /**
15: * Classes which implement this interface provide a method
16: * that deals with the events that are generated when a
17: * traverse event occurs in a control.
18: * <p>
19: * After creating an instance of a class that implements
20: * this interface it can be added to a control using the
21: * <code>addTraverseListener</code> method and removed using
22: * the <code>removeTraverseListener</code> method. When a
23: * traverse event occurs in a control, the keyTraversed method
24: * will be invoked.
25: * </p>
26: *
27: * @see TraverseEvent
28: */
29: public interface TraverseListener extends SWTEventListener {
30:
31: /**
32: * Sent when a traverse event occurs in a control.
33: * <p>
34: * A traverse event occurs when the user presses a traversal
35: * key. Traversal keys are typically tab and arrow keys, along
36: * with certain other keys on some platforms. Traversal key
37: * constants beginning with <code>TRAVERSE_</code> are defined
38: * in the <code>SWT</code> class.
39: * </p>
40: *
41: * @param e an event containing information about the traverse
42: */
43: public void keyTraversed(TraverseEvent e);
44: }
|