org.eclipse.swt.events.MouseWheelListener Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (c) 2000, 2007 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.events;


import org.eclipse.swt.internal.SWTEventListener;

/**
 * Classes which implement this interface provide a method
 * that deals with the event that is generated as the mouse
 * wheel is scrolled.
 * 
 * After creating an instance of a class that implements
 * this interface it can be added to a control using the
 * addMouseWheelListener method and removed using
 * the removeMouseWheelListener method. When the
 * mouse wheel is scrolled the mouseScrolled method
 * will be invoked.
 * 
 *
 * @see MouseEvent
 *
 * @since 3.3
 */
public interface MouseWheelListener extends SWTEventListener {

/**
 * Sent when the mouse wheel is scrolled.
 *
 * @param e an event containing information about the mouse wheel action
 */
public void mouseScrolled (MouseEvent e);
}