org.eclipse.swt.events.ArmListener source code

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.ArmListener;
14 
15 public import org.eclipse.swt.internal.SWTEventListener;
16 public import org.eclipse.swt.events.ArmEvent;
17 
18 /**
19  * Classes which implement this interface provide a method
20  * that deals with the event that is generated when a widget,
21  * such as a menu item, is armed.
22  * <p>
23  * After creating an instance of a class that :
24  * this interface it can be added to a widget using the
25  * <code>addArmListener</code> method and removed using
26  * the <code>removeArmListener</code> method. When the
27  * widget is armed, the widgetArmed method will be invoked.
28  * </p>
29  *
30  * @see ArmEvent
31  */
32 public interface ArmListener : SWTEventListener {
33 
34 /**
35  * Sent when a widget is armed, or 'about to be selected'.
36  *
37  * @param e an event containing information about the arm
38  */
39 public void widgetArmed(ArmEvent e);
40 }