Mercurial > projects > dwt-addons
diff dwtx/jface/text/contentassist/ICompletionProposalExtension5.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/ICompletionProposalExtension5.d Sat Aug 23 19:10:48 2008 +0200 @@ -0,0 +1,46 @@ +/******************************************************************************* + * 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.contentassist.ICompletionProposalExtension5; + +import dwt.dwthelper.utils; + +import dwtx.core.runtime.IProgressMonitor; + +/** + * Extends {@link dwtx.jface.text.contentassist.ICompletionProposal} with the following + * function: + * <ul> + * <li>Allow background computation of the additional info.</li> + * </ul> + * + * @since 3.2 + */ +public interface ICompletionProposalExtension5 { + /** + * Returns additional information about the proposal. The additional information will be + * presented to assist the user in deciding if the selected proposal is the desired choice. + * <p> + * This method may be called on a non-UI thread. + * </p> + * <p> + * By default, the returned information is converted to a string and displayed as text; if + * {@link ICompletionProposalExtension3#getInformationControlCreator()} is implemented, the + * information will be passed to a custom information control for display. + * </p> + * + * @param monitor a monitor to report progress and to watch for + * {@link IProgressMonitor#isCanceled() cancelation}. + * @return the additional information, <code>null</code> for no information + */ + Object getAdditionalProposalInfo(IProgressMonitor monitor); +}