01: /*******************************************************************************
02: * Copyright (c) 2000, 2003 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.swt.events;
11:
12: import org.eclipse.swt.internal.SWTEventListener;
13:
14: /**
15: * Classes which implement this interface provide methods
16: * that deal with the events that are generated as the mouse
17: * pointer passes (or hovers) over controls.
18: * <p>
19: * After creating an instance of a class that implements
20: * this interface it can be added to a control using the
21: * <code>addMouseTrackListener</code> method and removed using
22: * the <code>removeMouseTrackListener</code> method. When the
23: * mouse pointer passes into or out of the area of the screen
24: * covered by a control or pauses while over a control, the
25: * appropriate method will be invoked.
26: * </p>
27: *
28: * @see MouseTrackAdapter
29: * @see MouseEvent
30: */
31: public interface MouseTrackListener extends SWTEventListener {
32:
33: /**
34: * Sent when the mouse pointer passes into the area of
35: * the screen covered by a control.
36: *
37: * @param e an event containing information about the mouse enter
38: */
39: public void mouseEnter(MouseEvent e);
40:
41: /**
42: * Sent when the mouse pointer passes out of the area of
43: * the screen covered by a control.
44: *
45: * @param e an event containing information about the mouse exit
46: */
47: public void mouseExit(MouseEvent e);
48:
49: /**
50: * Sent when the mouse pointer hovers (that is, stops moving
51: * for an (operating system specified) period of time) over
52: * a control.
53: *
54: * @param e an event containing information about the hover
55: */
56: public void mouseHover(MouseEvent e);
57: }
|