|
129
|
1 /*******************************************************************************
|
|
|
2 * Copyright (c) 2000, 2008 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.ICompletionProposalExtension3;
|
|
|
14
|
|
|
15 import dwt.dwthelper.utils;
|
|
|
16
|
|
|
17 import dwtx.jface.text.IDocument;
|
|
|
18 import dwtx.jface.text.IInformationControlCreator;
|
|
|
19
|
|
|
20
|
|
|
21 /**
|
|
|
22 * Extends {@link dwtx.jface.text.contentassist.ICompletionProposal}
|
|
|
23 * with the following functions:
|
|
|
24 * <ul>
|
|
|
25 * <li>provision of a custom information control creator</li>
|
|
|
26 * <li>provide a custom completion text and offset for prefix completion</li>
|
|
|
27 * </ul>
|
|
|
28 *
|
|
|
29 * @since 3.0
|
|
|
30 */
|
|
|
31 public interface ICompletionProposalExtension3 {
|
|
|
32 /**
|
|
|
33 * Returns the information control creator of this completion proposal.
|
|
|
34 *
|
|
|
35 * @return the information control creator, or <code>null</code> if no custom control creator is available
|
|
|
36 */
|
|
|
37 IInformationControlCreator getInformationControlCreator();
|
|
|
38
|
|
|
39 /**
|
|
|
40 * Returns the string that would be inserted at the position returned from
|
|
|
41 * {@link #getPrefixCompletionStart(IDocument, int)} if this proposal was
|
|
|
42 * applied. If the replacement string cannot be determined,
|
|
|
43 * <code>null</code> may be returned.
|
|
|
44 *
|
|
|
45 * @param document the document that the receiver applies to
|
|
|
46 * @param completionOffset the offset into <code>document</code> where the
|
|
|
47 * completion takes place
|
|
|
48 * @return the replacement string or <code>null</code> if it cannot be
|
|
|
49 * determined
|
|
|
50 */
|
|
|
51 CharSequence getPrefixCompletionText(IDocument document, int completionOffset);
|
|
|
52
|
|
|
53 /**
|
|
|
54 * Returns the document offset at which the receiver would insert its
|
|
|
55 * proposal.
|
|
|
56 *
|
|
|
57 * @param document the document that the receiver applies to
|
|
|
58 * @param completionOffset the offset into <code>document</code> where the
|
|
|
59 * completion takes place
|
|
|
60 * @return the offset at which the proposal would insert its proposal
|
|
|
61 */
|
|
|
62 int getPrefixCompletionStart(IDocument document, int completionOffset);
|
|
|
63
|
|
|
64 }
|
