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 *******************************************************************************/ 11 package org.eclipse.swt.events; 12 13 14 import org.eclipse.swt.internal.SWTEventListener; 15 16 /** 17 * Classes which implement this interface provide methods 18 * that deal with the events that are generated as the mouse 19 * pointer passes (or hovers) over controls. 20 * <p> 21 * After creating an instance of a class that implements 22 * this interface it can be added to a control using the 23 * <code>addMouseTrackListener</code> method and removed using 24 * the <code>removeMouseTrackListener</code> method. When the 25 * mouse pointer passes into or out of the area of the screen 26 * covered by a control or pauses while over a control, the 27 * appropriate method will be invoked. 28 * </p> 29 * 30 * @see MouseTrackAdapter 31 * @see MouseEvent 32 */ 33 public interface MouseTrackListener extends SWTEventListener { 34 35 /** 36 * Sent when the mouse pointer passes into the area of 37 * the screen covered by a control. 38 * 39 * @param e an event containing information about the mouse enter 40 */ 41 public void mouseEnter(MouseEvent e); 42 43 /** 44 * Sent when the mouse pointer passes out of the area of 45 * the screen covered by a control. 46 * 47 * @param e an event containing information about the mouse exit 48 */ 49 public void mouseExit(MouseEvent e); 50 51 /** 52 * Sent when the mouse pointer hovers (that is, stops moving 53 * for an (operating system specified) period of time) over 54 * a control. 55 * 56 * @param e an event containing information about the hover 57 */ 58 public void mouseHover(MouseEvent e); 59 } 60