Mercurial > projects > dwt-mac
diff dwt/widgets/Listener.d @ 0:380af2bdd8e5
Upload of whole dwt tree
author | Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com> |
---|---|
date | Sat, 09 Aug 2008 17:00:02 +0200 |
parents | |
children | 2952d5604c0a |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/dwt/widgets/Listener.d Sat Aug 09 17:00:02 2008 +0200 @@ -0,0 +1,54 @@ +/******************************************************************************* + * Copyright (c) 2000, 2005 IBM Corporation and others. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * IBM Corporation - initial API and implementation + *******************************************************************************/ +module dwt.widgets.Listener; + +import dwt.dwthelper.utils; + + +/** + * Implementers of <code>Listener</code> provide a simple + * <code>handleEvent()</code> method that is used internally + * by DWT to dispatch events. + * <p> + * After creating an instance of a class that implements this interface + * it can be added to a widget using the + * <code>addListener(int eventType, Listener handler)</code> method and + * removed using the + * <code>removeListener (int eventType, Listener handler)</code> method. + * When the specified event occurs, <code>handleEvent(...)</code> will + * be sent to the instance. + * </p> + * <p> + * Classes which implement this interface are described within DWT as + * providing the <em>untyped listener</em> API. Typically, widgets will + * also provide a higher-level <em>typed listener</em> API, that is based + * on the standard <code>java.util.EventListener</code> pattern. + * </p> + * <p> + * Note that, since all internal DWT event dispatching is based on untyped + * listeners, it is simple to build subsets of DWT for use on memory + * constrained, small footprint devices, by removing the classes and + * methods which implement the typed listener API. + * </p> + * + * @see Widget#addListener + * @see java.util.EventListener + * @see dwt.events + */ +public interface Listener { + +/** + * Sent when an event that the receiver has registered for occurs. + * + * @param event the event which occurred + */ +void handleEvent (Event event); +}