diff dwtx/jface/text/source/IAnnotationPresentation.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/IAnnotationPresentation.d	Sat Aug 23 19:10:48 2008 +0200
@@ -0,0 +1,53 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 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.IAnnotationPresentation;
+
+import dwt.dwthelper.utils;
+
+import dwt.graphics.GC;
+import dwt.graphics.Rectangle;
+import dwt.widgets.Canvas;
+
+/**
+ * Interface for annotations that can take care of their own visible representation.
+ *
+ * @since 3.0
+ */
+public interface IAnnotationPresentation {
+
+    /**
+     * The default annotation layer.
+     */
+    static final int DEFAULT_LAYER= 0;
+
+
+    /**
+     * Returns the annotations drawing layer.
+     *
+     * @return the annotations drawing layer
+     */
+    int getLayer();
+
+    /**
+     * Implement this method to draw a graphical representation
+     * of this annotation within the given bounds.
+     * <p>
+     * <em>Note that this method is not used when drawing annotations on the editor's
+     * text widget. This is handled trough a {@link dwtx.jface.text.source.AnnotationPainter.IDrawingStrategy}.</em>
+     * </p>
+     * @param gc the drawing GC
+     * @param canvas the canvas to draw on
+     * @param bounds the bounds inside the canvas to draw on
+     */
+    void paint(GC gc, Canvas canvas, Rectangle bounds);
+}