Mercurial > projects > dwt-addons

comparison dwtx/jface/text/IDocumentPartitionerExtension.d @ 129:eb30df5ca28b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added JFace Text sources
author Frank Benoit <benoit@tionex.de>
date Sat, 23 Aug 2008 19:10:48 +0200
parents
children c4fb132a086c
comparison
equal deleted inserted replaced
128:8df1d4193877 129:eb30df5ca28b
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
14 module dwtx.jface.text.IDocumentPartitionerExtension;
15
16 import dwt.dwthelper.utils;
17
18
19 /**
20 * Extension interface for {@link dwtx.jface.text.IDocumentPartitioner}.
21 * <p>
22 * Replaces the original concept of the document partitioner by returning the
23 * minimal region that includes all partition changes caused by the invocation
24 * of the document partitioner.
25 * The method <code>documentChanged2</code> is considered the replacement of
26 * {@link dwtx.jface.text.IDocumentPartitioner#documentChanged(DocumentEvent)}.
27 *
28 * @since 2.0
29 */
30 public interface IDocumentPartitionerExtension {
31
32 /**
33 * The document has been changed. The partitioner updates the document's
34 * partitioning and returns the minimal region that comprises all partition
35 * changes caused in response to the given document event. This method
36 * returns <code>null</code> if the partitioning did not change.
37 * <p>
38 *
39 * Will be called by the connected document and is not intended to be used
40 * by clients other than the connected document.
41 * <p>
42 * Replaces {@link IDocumentPartitioner#documentChanged(DocumentEvent)}.
43 *
44 * @param event the event describing the document change
45 * @return the region of the document in which the partition type changed or <code>null</code>
46 */
47 IRegion documentChanged2(DocumentEvent event);
48 }