blob: 95d4d94714c53534f394b06be96bd70ac530d77d [file] [log] [blame]
package org.eclipse.swt.events;
/*
* Copyright (c) 2000, 2002 IBM Corp. All rights reserved.
* This file is made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*/
import org.eclipse.swt.internal.SWTEventListener;
/**
* Classes which implement this interface provide a method
* that deals with the events that are generated when a
* traverse event occurs in a control.
* <p>
* After creating an instance of a class that implements
* this interface it can be added to a control using the
* <code>addTraverseListener</code> method and removed using
* the <code>removeTraverseListener</code> method. When a
* traverse event occurs in a control, the keyTraversed method
* will be invoked.
* </p>
*
* @see TraverseEvent
*/
public interface TraverseListener extends SWTEventListener {
/**
* Sent when a traverse event occurs in a control.
* <p>
* A traverse event occurs when the user presses a traversal
* key. Traversal keys are typically tab and arrow keys, along
* with certain other keys on some platforms. Traversal key
* constants beginning with <code>TRAVERSE_</code> are defined
* in the <code>SWT</code> class.
* </p>
*
* @param e an event containing information about the traverse
*/
public void keyTraversed(TraverseEvent e);
}