diff dwtx/jface/text/contentassist/IContextInformationPresenter.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/contentassist/IContextInformationPresenter.d	Sat Aug 23 19:10:48 2008 +0200
@@ -0,0 +1,51 @@
+/*******************************************************************************
+ * 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.contentassist.IContextInformationPresenter;
+
+import dwt.dwthelper.utils;
+
+import dwtx.jface.text.ITextViewer;
+import dwtx.jface.text.TextPresentation;
+
+
+/**
+ * A context information presenter determines the presentation
+ * of context information depending on a given document position.
+ * <p>
+ * The interface can be implemented by clients.
+ * </p>
+ *
+ * @since 2.0
+ */
+public interface IContextInformationPresenter {
+
+    /**
+     * Installs this presenter for the given context information.
+     *
+     * @param info the context information which this presenter should style
+     * @param viewer the text viewer on which the information is presented
+     * @param offset the document offset for which the information has been computed
+     */
+    void install(IContextInformation info, ITextViewer viewer, int offset);
+
+    /**
+     * Updates the given presentation of the given context information
+     * at the given document position. Returns whether update changed the
+     * presentation.
+     *
+     * @param offset the current offset within the document
+     * @param presentation the presentation to be updated
+     * @return <code>true</code> if the given presentation has been changed
+     */
+    bool updatePresentation(int offset, TextPresentation presentation);
+}