Mercurial > projects > dwt-addons
diff dwtx/jface/text/contentassist/IContextInformation.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/IContextInformation.d Sat Aug 23 19:10:48 2008 +0200 @@ -0,0 +1,79 @@ +/******************************************************************************* + * 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.IContextInformation; + +import dwt.dwthelper.utils; + +import dwt.graphics.Image; + + +/** + * The interface of context information presented to the user and + * generated by content assist processors. + * <p> + * In order to provide backward compatibility for clients of + * <code>IContextInformation</code>, extension interfaces are used to + * provide a means of evolution. The following extension interfaces + * exist: + * <ul> + * <li>{@link dwtx.jface.text.contentassist.IContextInformationExtension} + * since version 2.0 introducing the ability to freely position the + * context information.</li> + * </ul> + * </p> + * <p> + * The interface can be implemented by clients. By default, clients use + * {@link dwtx.jface.text.contentassist.ContextInformation} as + * the standard implementer of this interface. + * </p> + * + * @see IContentAssistProcessor + */ +public interface IContextInformation { + + /** + * Returns the string to be displayed in the list of contexts. + * This method is used to supply a unique presentation for + * situations where the context is ambiguous. These strings are + * used to allow the user to select the specific context. + * + * @return the string to be displayed for the context + */ + String getContextDisplayString(); + + /** + * Returns the image for this context information. + * The image will be shown to the left of the display string. + * + * @return the image to be shown or <code>null</code> if no image is desired + */ + Image getImage(); + + /** + * Returns the string to be displayed in the tool tip like information popup. + * + * @return the string to be displayed + */ + String getInformationDisplayString(); + + /** + * Compares the given object with this receiver. Two context informations are + * equal if there information display strings and their context display strings + * are equal. + * + * @see Object#equals(Object) + */ + bool equals(Object object); +} + +