diff dwtx/jface/text/source/ISourceViewerExtension3.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/ISourceViewerExtension3.d	Sat Aug 23 19:10:48 2008 +0200
@@ -0,0 +1,55 @@
+/*******************************************************************************
+ * Copyright (c) 2006 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.ISourceViewerExtension3;
+
+import dwt.dwthelper.utils;
+
+import dwtx.jface.text.quickassist.IQuickAssistAssistant;
+import dwtx.jface.text.quickassist.IQuickAssistInvocationContext;
+
+/**
+ * Extension interface for {@link dwtx.jface.text.source.ISourceViewer}.<p>
+ * It introduces the concept of a quick assist assistant and provides access
+ * to the quick assist invocation context. It also gives access to any currently 
+ * showing annotation hover.</p>
+ *
+ * @see IQuickAssistAssistant
+ * @see IQuickAssistInvocationContext
+ * @since 3.2
+ */
+public interface ISourceViewerExtension3 {
+
+    /**
+     * Returns this viewers quick assist assistant.
+     *
+     * @return the quick assist assistant or <code>null</code> if none is configured
+     * @since 3.2
+     */
+    public IQuickAssistAssistant getQuickAssistAssistant();
+
+    /**
+     * Returns this viewer's quick assist invocation context.
+     *
+     * @return the quick assist invocation context or <code>null</code> if none is available
+     */
+    IQuickAssistInvocationContext getQuickAssistInvocationContext();
+
+    /**
+     * Returns the currently displayed annotation hover if any, <code>null</code> otherwise.
+     *
+     * @return the currently displayed annotation hover or <code>null</code>
+     */
+    IAnnotationHover getCurrentAnnotationHover();
+
+}