bundles/org.eclipse.swt.win32.win32.x86_64/src/org/eclipse/swt/custom/VerifyKeyListener.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2016 IBM Corporation and others.
   3  *
   4  * This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License 2.0
   6  * which accompanies this distribution, and is available at
   7  * https://www.eclipse.org/legal/epl-2.0/
   8  *
   9  * SPDX-License-Identifier: EPL-2.0
  10  *
  11  * Contributors:
  12  *     IBM Corporation - initial API and implementation
  13  *******************************************************************************/
  14 package org.eclipse.swt.custom;
  15
  16 import org.eclipse.swt.events.*;
  17 import org.eclipse.swt.internal.*;
  18
  19 /**
  20  * Classes which implement this interface provide a method
  21  * that deals with the event that is generated when a
  22  * key is pressed.
  23  *
  24  * @see VerifyEvent
  25  * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
  26  */
  27 @FunctionalInterface
  28 public interface VerifyKeyListener extends SWTEventListener {
  29 /**
  30  * The following event fields are used:<ul>
  31  * <li>event.character is the character that was typed (input)</li>
  32  * <li>event.keyCode is the key code that was typed (input)</li>
  33  * <li>event.stateMask is the state of the keyboard (input)</li>
  34  * <li>event.doit is processed or not (output)</li>
  35  * </ul>
  36  * @param event the verify event
  37  * @see VerifyEvent
  38  */
  39 public void verifyKey (VerifyEvent event);
  40 }