| /******************************************************************************* |
| * Copyright (c) 2000, 2005 IBM Corporation and others. |
| * |
| * This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License 2.0 |
| * which accompanies this distribution, and is available at |
| * https://www.eclipse.org/legal/epl-2.0/ |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.jface.text; |
| |
| |
| |
| import org.eclipse.swt.events.VerifyEvent; |
| |
| /** |
| * Implementers can register with a text viewer and receive <code>VerifyEvent</code>s before the |
| * text viewer they are registered with. If the event consumer marks events as processed by turning |
| * their <code>doit</code> field to <code>false</code> the text viewer subsequently ignores them. |
| * <p> |
| * Clients may implement this interface. |
| * </p> |
| * <p> |
| * {@link org.eclipse.jface.text.ITextViewerExtension2}allows clients to manage the |
| * {@link org.eclipse.swt.events.VerifyListener}s of a text viewer. This makes |
| * <code>IEventConsumer</code> obsolete. |
| * </p> |
| * |
| * @see org.eclipse.jface.text.ITextViewer |
| * @see org.eclipse.jface.text.ITextViewerExtension2 |
| * @see org.eclipse.swt.events.VerifyEvent |
| */ |
| public interface IEventConsumer { |
| |
| /** |
| * Processes the given event and marks it as done if it should |
| * be ignored by subsequent receivers. |
| * |
| * @param event the verify event which will be investigated |
| */ |
| public void processEvent(VerifyEvent event); |
| } |
