org.eclipse.swt.events.MouseListener source code

1 /*******************************************************************************
2  * Copyright (c) 2000, 2004 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.MouseListener;
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 mouse buttons
22  * are pressed.
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>addMouseListener</code> method and removed using
27  * the <code>removeMouseListener</code> method. When a
28  * mouse button is pressed or released, the appropriate method
29  * will be invoked.
30  * </p>
31  *
32  * @see MouseAdapter
33  * @see MouseEvent
34  */
35 public interface MouseListener : SWTEventListener {
36 
37 /**
38  * Sent when a mouse button is pressed twice within the
39  * (operating system specified) double click period.
40  *
41  * @param e an event containing information about the mouse double click
42  *
43  * @see org.eclipse.swt.widgets.Display#getDoubleClickTime()
44  */
45 public void mouseDoubleClick(MouseEvent e);
46 
47 /**
48  * Sent when a mouse button is pressed.
49  *
50  * @param e an event containing information about the mouse button press
51  */
52 public void mouseDown(MouseEvent e);
53 
54 /**
55  * Sent when a mouse button is released.
56  *
57  * @param e an event containing information about the mouse button release
58  */
59 public void mouseUp(MouseEvent e);
60 }