org.eclipse.swt.events.MouseTrackAdapter source code

1 /*******************************************************************************
2  * Copyright (c) 2000, 2008 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.MouseTrackAdapter;
14 
15 import org.eclipse.swt.events.MouseTrackListener;
16 
17 /**
18  * This adapter class provides default implementations for the
19  * methods described by the <code>MouseTrackListener</code> interface.
20  * <p>
21  * Classes that wish to deal with <code>MouseEvent</code>s which
22  * occur as the mouse pointer passes (or hovers) over controls can
23  * extend this class and override only the methods which they are
24  * interested in.
25  * </p>
26  *
27  * @see MouseTrackListener
28  * @see MouseEvent
29  * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
30  */
31 public abstract class MouseTrackAdapter : MouseTrackListener {
32 
33 /**
34  * Sent when the mouse pointer passes into the area of
35  * the screen covered by a control.
36  * The default behavior is to do nothing.
37  *
38  * @param e an event containing information about the mouse enter
39  */
40 public void mouseEnter(MouseEvent e) {
41 }
42 
43 /**
44  * Sent when the mouse pointer passes out of the area of
45  * the screen covered by a control.
46  * The default behavior is to do nothing.
47  *
48  * @param e an event containing information about the mouse exit
49  */
50 public void mouseExit(MouseEvent e) {
51 }
52 
53 /**
54  * Sent when the mouse pointer hovers (that is, stops moving
55  * for an (operating system specified) period of time) over
56  * a control.
57  * The default behavior is to do nothing.
58  *
59  * @param e an event containing information about the hover
60  */
61 public void mouseHover(MouseEvent e) {
62 }
63 }