Mercurial > projects > dwt2

comparison org.eclipse.jface/src/org/eclipse/jface/fieldassist/IContentProposal.d @ 12:bc29606a740c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added dwt-addons in original directory structure of eclipse.org
author Frank Benoit <benoit@tionex.de>
date Sat, 14 Mar 2009 18:23:29 +0100
parents
children
comparison
equal deleted inserted replaced
11:43904fec5dca 12:bc29606a740c
1 /*******************************************************************************
2 * Copyright (c) 2005, 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 org.eclipse.jface.fieldassist.IContentProposal;
14
15 import java.lang.all;
16
17 /**
18 * IContentProposal describes a content proposal to be shown. It consists of the
19 * content that will be provided if the proposal is accepted, an optional label
20 * used to describe the content to the user, and an optional description that
21 * further elaborates the meaning of the proposal.
22 *
23 * @since 3.2
24 */
25 public interface IContentProposal {
26 /**
27 * Return the content represented by this proposal.
28 *
29 * @return the String content represented by this proposal.
30 */
31 public String getContent();
32
33 /**
34 * Return the integer position within the contents that the cursor should be
35 * placed after the proposal is accepted.
36 *
37 * @return the zero-based index position within the contents where the
38 * cursor should be placed after the proposal is accepted.
39 */
40 public int getCursorPosition();
41
42 /**
43 * Return the label used to describe this proposal.
44 *
45 * @return the String label used to display the proposal. If
46 * <code>null</code>, then the content will be displayed as the
47 * label.
48 */
49 public String getLabel();
50
51 /**
52 * Return a description that describes this proposal.
53 *
54 * @return the String label used to further the proposal. If
55 * <code>null</code>, then no description will be displayed.
56 */
57 public String getDescription();
58
59 }