annotate dwt/events/VerifyListener.d @ 9:ad2b69216039

moved org.eclipse.swt to dwt
author Frank Benoit <benoit@tionex.de>
date Sat, 05 Jan 2008 17:39:49 +0100
parents org/eclipse/swt/events/VerifyListener.d@5dfd6e42e2ef
children 63c023465156
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2005 IBM Corporation and others.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 *******************************************************************************/
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 module org.eclipse.swt.events.VerifyListener;
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13
3
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents: 2
diff changeset
14 public import org.eclipse.swt.internal.SWTEventListener;
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents: 2
diff changeset
15 public import org.eclipse.swt.events.VerifyEvent;
2
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 /**
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 * Classes which implement this interface provide a method
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 * that deals with the events that are generated when text
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 * is about to be modified.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * <p>
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * After creating an instance of a class that :
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * this interface it can be added to a text control using the
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * <code>addVerifyListener</code> method and removed using
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * the <code>removeVerifyListener</code> method. When the
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * text is about to be modified, the verifyText method
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * will be invoked.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * </p>
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 *
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * @see VerifyEvent
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 */
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 public interface VerifyListener : SWTEventListener {
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 /**
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * Sent when the text is about to be modified.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * <p>
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * A verify event occurs after the user has done something
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * to modify the text (typically typed a key), but before
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * the text is modified. The doit field in the verify event
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * indicates whether or not to modify the text.
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * </p>
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 *
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 * @param e an event containing information about the verify
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 */
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 public void verifyText(VerifyEvent e);
b8884f396ec8 some listeners
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 }