org.eclipse.swt.events.MouseTrackListener source code

1 /*******************************************************************************
2  * Copyright (c) 2000, 2003 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.MouseTrackListener;
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 methods
21  * that deal with the events that are generated as the mouse
22  * pointer passes (or hovers) over controls.
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>addMouseTrackListener</code> method and removed using
27  * the <code>removeMouseTrackListener</code> method. When the
28  * mouse pointer passes into or out of the area of the screen
29  * covered by a control or pauses while over a control, the
30  * appropriate method will be invoked.
31  * </p>
32  *
33  * @see MouseTrackAdapter
34  * @see MouseEvent
35  */
36 public interface MouseTrackListener : SWTEventListener {
37 
38 /**
39  * Sent when the mouse pointer passes into the area of
40  * the screen covered by a control.
41  *
42  * @param e an event containing information about the mouse enter
43  */
44 public void mouseEnter(MouseEvent e);
45 
46 /**
47  * Sent when the mouse pointer passes out of the area of
48  * the screen covered by a control.
49  *
50  * @param e an event containing information about the mouse exit
51  */
52 public void mouseExit(MouseEvent e);
53 
54 /**
55  * Sent when the mouse pointer hovers (that is, stops moving
56  * for an (operating system specified) period of time) over
57  * a control.
58  *
59  * @param e an event containing information about the hover
60  */
61 public void mouseHover(MouseEvent e);
62 }