|
129
|
1 /*******************************************************************************
|
|
|
2 * Copyright (c) 2000, 2005 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 dwtx.jface.text.IEventConsumer;
|
|
|
14
|
|
|
15 import dwt.dwthelper.utils;
|
|
|
16
|
|
|
17
|
|
|
18
|
|
|
19 import dwt.events.VerifyEvent;
|
|
|
20
|
|
|
21 /**
|
|
|
22 * Implementers can register with a text viewer and receive
|
|
|
23 * <code>VerifyEvent</code>s before the text viewer they are registered with.
|
|
|
24 * If the event consumer marks events as processed by turning their
|
|
|
25 * <code>doit</code> field to <code>false</code> the text viewer
|
|
|
26 * subsequently ignores them.</p>
|
|
|
27 * <p>
|
|
|
28 * Clients may implement this interface.</p>
|
|
|
29 * <p>
|
|
|
30 * {@link dwtx.jface.text.ITextViewerExtension2}allows clients to manage
|
|
|
31 * the {@link dwt.events.VerifyListener}s of a text viewer. This
|
|
|
32 * makes <code>IEventConsumer</code> obsolete.</p>
|
|
|
33 *
|
|
|
34 * @see dwtx.jface.text.ITextViewer
|
|
|
35 * @see dwtx.jface.text.ITextViewerExtension2
|
|
|
36 * @see dwt.events.VerifyEvent
|
|
|
37 */
|
|
|
38 public interface IEventConsumer {
|
|
|
39
|
|
|
40 /**
|
|
|
41 * Processes the given event and marks it as done if it should
|
|
|
42 * be ignored by subsequent receivers.
|
|
|
43 *
|
|
|
44 * @param event the verify event which will be investigated
|
|
|
45 */
|
|
|
46 public void processEvent(VerifyEvent event);
|
|
|
47 }
|
