blob: 653e203387055ed1aa2e084d862d199b38a91fd9 [file] [log] [blame]
/*******************************************************************************
* 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
*******************************************************************************/
package org.eclipse.swt.events;
import org.eclipse.swt.internal.SWTEventListener;
/**
* Classes which implement this interface provide a method
* that deals with the events that are generated when text
* is about to be modified.
* <p>
* After creating an instance of a class that implements
* this interface it can be added to a text control using the
* <code>addVerifyListener</code> method and removed using
* the <code>removeVerifyListener</code> method. When the
* text is about to be modified, the verifyText method
* will be invoked.
* </p>
*
* @see VerifyEvent
*/
public interface VerifyListener extends SWTEventListener {
/**
* Sent when the text is about to be modified.
* <p>
* A verify event occurs after the user has done something
* to modify the text (typically typed a key), but before
* the text is modified. The doit field in the verify event
* indicates whether or not to modify the text.
* </p>
*
* @param e an event containing information about the verify
*/
public void verifyText(VerifyEvent e);
}