bundles/org.eclipse.swt.win32.win32.x86_64/src/org/eclipse/swt/events/MouseWheelListener.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2017 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.events;
  15
  16
  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 as the mouse
  22  * wheel is scrolled.
  23  * <p>
  24  * After creating an instance of a class that implements
  25  * this interface it can be added to a control using the
  26  * <code>addMouseWheelListener</code> method and removed using
  27  * the <code>removeMouseWheelListener</code> method. When the
  28  * mouse wheel is scrolled the <code>mouseScrolled</code> method
  29  * will be invoked.
  30  * </p>
  31  *
  32  * @see MouseEvent
  33  *
  34  * @since 3.3
  35  */
  36 @FunctionalInterface
  37 public interface MouseWheelListener extends SWTEventListener {
  38
  39 /**
  40  * Sent when the mouse wheel is scrolled.
  41  *
  42  * @param e an event containing information about the mouse wheel action
  43  */
  44 void mouseScrolled (MouseEvent e);
  45 }