org.eclipse.swt.custom.VerifyKeyListener Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (c) 2000, 2016 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.swt.custom;

import org.eclipse.swt.events.*;
import org.eclipse.swt.internal.*;

/**
 * Classes which implement this interface provide a method
 * that deals with the event that is generated when a
 * key is pressed.
 *
 * @see VerifyEvent
 * @see Sample code and further information
 */
@FunctionalInterface
public interface VerifyKeyListener extends SWTEventListener {
/**
 * The following event fields are used:
 * event.character is the character that was typed (input)
 * event.keyCode is the key code that was typed (input)
 * event.stateMask is the state of the keyboard (input)
 * event.doit is processed or not (output)
 * 
 * @param event the verify event
 * @see VerifyEvent
 */
public void verifyKey (VerifyEvent event);
}