bundles/org.eclipse.swt.win32.win32.x86_64/src/org/eclipse/swt/events/ArmListener.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  *     Lars Vogel <Lars.Vogel@vogella.com> - Bug 502576
  14  *******************************************************************************/
  15 package org.eclipse.swt.events;
  16
  17
  18 import org.eclipse.swt.internal.*;
  19
  20 /**
  21  * Classes which implement this interface provide a method
  22  * that deals with the event that is generated when a widget,
  23  * such as a menu item, is armed.
  24  * <p>
  25  * After creating an instance of a class that implements
  26  * this interface it can be added to a widget using the
  27  * <code>addArmListener</code> method and removed using
  28  * the <code>removeArmListener</code> method. When the
  29  * widget is armed, the widgetArmed method will be invoked.
  30  * </p>
  31  *
  32  * @see ArmEvent
  33  */
  34 @FunctionalInterface
  35 public interface ArmListener extends SWTEventListener {
  36
  37 /**
  38  * Sent when a widget is armed, or 'about to be selected'.
  39  *
  40  * @param e an event containing information about the arm
  41  */
  42 void widgetArmed(ArmEvent e);
  43 }