Mercurial > projects > dwt-addons

comparison dwtx/jface/text/contentassist/ICompletionProposalExtension5.d @ 129:eb30df5ca28b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added JFace Text sources
author Frank Benoit <benoit@tionex.de>
date Sat, 23 Aug 2008 19:10:48 +0200
parents
children c4fb132a086c
comparison
equal deleted inserted replaced
128:8df1d4193877 129:eb30df5ca28b
1 /*******************************************************************************
2 * Copyright (c) 2006 IBM Corporation and others.
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the Eclipse Public License v1.0
5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/epl-v10.html
7 *
8 * Contributors:
9 * IBM Corporation - initial API and implementation
10 * Port to the D programming language:
11 * Frank Benoit <benoit@tionex.de>
12 *******************************************************************************/
13 module dwtx.jface.text.contentassist.ICompletionProposalExtension5;
14
15 import dwt.dwthelper.utils;
16
17 import dwtx.core.runtime.IProgressMonitor;
18
19 /**
20 * Extends {@link dwtx.jface.text.contentassist.ICompletionProposal} with the following
21 * function:
22 * <ul>
23 * <li>Allow background computation of the additional info.</li>
24 * </ul>
25 *
26 * @since 3.2
27 */
28 public interface ICompletionProposalExtension5 {
29 /**
30 * Returns additional information about the proposal. The additional information will be
31 * presented to assist the user in deciding if the selected proposal is the desired choice.
32 * <p>
33 * This method may be called on a non-UI thread.
34 * </p>
35 * <p>
36 * By default, the returned information is converted to a string and displayed as text; if
37 * {@link ICompletionProposalExtension3#getInformationControlCreator()} is implemented, the
38 * information will be passed to a custom information control for display.
39 * </p>
40 *
41 * @param monitor a monitor to report progress and to watch for
42 * {@link IProgressMonitor#isCanceled() cancelation}.
43 * @return the additional information, <code>null</code> for no information
44 */
45 Object getAdditionalProposalInfo(IProgressMonitor monitor);
46 }