1 /*******************************************************************************
2 * Copyright (c) 2000, 2016 IBM Corporation and others.
3 *
4 * This program and the accompanying materials
5 * are made available under the terms of the Eclipse Public License 2.0
6 * which accompanies this distribution, and is available at
7 * https://www.eclipse.org/legal/epl-2.0/
8 *
9 * SPDX-License-Identifier: EPL-2.0
10 *
11 * Contributors:
12 * IBM Corporation - initial API and implementation
13 * Lars Vogel <Lars.Vogel@vogella.com> - Bug 502576
14 *******************************************************************************/
15 package org.eclipse.swt.events;
16
17
18 import org.eclipse.swt.internal.*;
19
20 /**
21 * Classes which implement this interface provide a method
22 * that deals with the event that is generated when help is
23 * requested for a control, typically when the user presses F1.
24 * <p>
25 * After creating an instance of a class that implements
26 * this interface it can be added to a control using the
27 * <code>addHelpListener</code> method and removed using
28 * the <code>removeHelpListener</code> method. When help
29 * is requested for a control, the helpRequested method
30 * will be invoked.
31 * </p>
32 *
33 * @see HelpEvent
34 */
35 @FunctionalInterface
36 public interface HelpListener extends SWTEventListener {
37
38 /**
39 * Sent when help is requested for a control, typically
40 * when the user presses F1.
41 *
42 * @param e an event containing information about the help
43 */
helpRequested(HelpEvent e)44 void helpRequested(HelpEvent e);
45 }
46