diff dwtx/jface/text/source/ISourceViewerExtension.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/source/ISourceViewerExtension.d	Sat Aug 23 19:10:48 2008 +0200
@@ -0,0 +1,42 @@
+/*******************************************************************************
+ * 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.source.ISourceViewerExtension;
+
+import dwt.dwthelper.utils;
+
+/**
+ * Extension interface {@link dwtx.jface.text.source.ISourceViewer}.
+ * <p>
+ * Extends the source viewer with the concept of an annotation overview. The
+ * annotation overview differs from the annotation presentation in that it is
+ * independent from the viewer's view port, i.e. the annotations of the whole
+ * document are visible. There are no assumptions about the area in which the
+ * annotation overview is shown.
+ * <p>
+ * As the visibility of annotation overview can dynamically be changed, it is
+ * assumed that the presentation area can dynamically be hidden if it is
+ * different from the text widget.
+ *
+ * @see dwtx.jface.text.source.ISourceViewer
+ * @since 2.1
+ */
+public interface ISourceViewerExtension {
+
+    /**
+     * Shows/hides an overview representation of the annotations of the whole document of this viewer.
+     *
+     * @param show <code>true</code> if annotation overview should be visible, <code>false</code> otherwise
+     */
+    void showAnnotationsOverview(bool show);
+}