org.eclipse.swt.events.MouseWheelListener source code

1 /*******************************************************************************
2  * Copyright (c) 2000, 2007 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  *     IBM Corporation - initial API and implementation
10  * Port to the D programming language:
11  *     Frank Benoit <benoit@tionex.de>
12  *******************************************************************************/
13 module org.eclipse.swt.events.MouseWheelListener;
14 
15 
16 public import org.eclipse.swt.internal.SWTEventListener;
17 public import org.eclipse.swt.events.MouseEvent;
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 :
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 public interface MouseWheelListener : SWTEventListener {
37 
38 /**
39  * Sent when the mouse wheel is scrolled.
40  *
41  * @param e an event containing information about the mouse wheel action
42  */
43 public void mouseScrolled (MouseEvent e);
44 }