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.HelpListener;
14 
15 
16 public import org.eclipse.swt.internal.SWTEventListener;
17 public import org.eclipse.swt.events.HelpEvent;
18 
19 /**
20  * Classes which implement this interface provide a method
21  * that deals with the event that is generated when help is
22  * requested for a control, typically when the user presses F1.
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>addHelpListener</code> method and removed using
27  * the <code>removeHelpListener</code> method. When help
28  * is requested for a control, the helpRequested method
29  * will be invoked.
30  * </p>
31  *
32  * @see HelpEvent
33  */
34 public interface HelpListener : SWTEventListener {
35 
36 /**
37  * Sent when help is requested for a control, typically
38  * when the user presses F1.
39  *
40  * @param e an event containing information about the help
41  */
42 public void helpRequested(HelpEvent e);
43 }