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

Added JFace Text sources
author Frank Benoit <benoit@tionex.de>
date Sat, 23 Aug 2008 19:10:48 +0200
parents
children c4fb132a086c
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/dwtx/jface/text/IDocumentPartitionerExtension.d	Sat Aug 23 19:10:48 2008 +0200
@@ -0,0 +1,48 @@
+/*******************************************************************************
+ * 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
+ * Port to the D programming language:
+ *     Frank Benoit <benoit@tionex.de>
+ *******************************************************************************/
+
+module dwtx.jface.text.IDocumentPartitionerExtension;
+
+import dwt.dwthelper.utils;
+
+
+/**
+ * Extension interface for {@link dwtx.jface.text.IDocumentPartitioner}.
+ * <p>
+ * Replaces the original concept of the document partitioner by returning the
+ * minimal region that includes all partition changes caused by the invocation
+ * of the document partitioner.
+ * The method <code>documentChanged2</code> is considered the replacement of
+ * {@link dwtx.jface.text.IDocumentPartitioner#documentChanged(DocumentEvent)}.
+ *
+ * @since 2.0
+ */
+public interface IDocumentPartitionerExtension {
+
+    /**
+     * The document has been changed. The partitioner updates the document's
+     * partitioning and returns the minimal region that comprises all partition
+     * changes caused in response to the given document event. This method
+     * returns <code>null</code> if the partitioning did not change.
+     * <p>
+     *
+     * Will be called by the connected document and is not intended to be used
+     * by clients other than the connected document.
+     * <p>
+     * Replaces {@link IDocumentPartitioner#documentChanged(DocumentEvent)}.
+     *
+     * @param event the event describing the document change
+     * @return the region of the document in which the partition type changed or <code>null</code>
+     */
+    IRegion documentChanged2(DocumentEvent event);
+}