KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > swt > events > HelpListener


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 a method
18  * that deals with the event that is generated when help is
19  * requested for a control, typically when the user presses F1.
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>addHelpListener</code> method and removed using
24  * the <code>removeHelpListener</code> method. When help
25  * is requested for a control, the helpRequested method
26  * will be invoked.
27  * </p>
28  *
29  * @see HelpEvent
30  */
31 public interface HelpListener extends SWTEventListener {
32
33 /**
34  * Sent when help is requested for a control, typically
35  * when the user presses F1.
36  *
37  * @param e an event containing information about the help
38  */
39 public void helpRequested(HelpEvent e);
40 }
41
Popular Tags