annotate dwtx/jface/contentassist/ISubjectControlContentAssistProcessor.d @ 158:25f1f92fa3df

...
author Frank Benoit <benoit@tionex.de>
date Tue, 26 Aug 2008 02:46:34 +0200
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
158
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2006 IBM Corporation and others.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 * Port to the D programming language:
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 * Frank Benoit <benoit@tionex.de>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwtx.jface.contentassist.ISubjectControlContentAssistProcessor;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 import dwt.dwthelper.utils;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 import dwtx.jface.text.contentassist.ICompletionProposal;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 import dwtx.jface.text.contentassist.IContentAssistProcessor;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 import dwtx.jface.text.contentassist.IContextInformation;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 import dwtx.jface.contentassist.IContentAssistSubjectControl;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * Extension interface for {@link dwtx.jface.text.contentassist.IContentAssistProcessor}
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * which provides the context for the
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * {@linkplain dwtx.jface.contentassist.ISubjectControlContentAssistant subject control content assistant}.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * @since 3.0
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * @deprecated As of 3.2, replaced by Platform UI's field assist support
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 public interface ISubjectControlContentAssistProcessor : IContentAssistProcessor {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * Returns a list of completion proposals based on the specified location
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * within the document that corresponds to the current cursor position
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * within the text viewer.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * @param contentAssistSubjectControl the content assist subject control whose
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * document is used to compute the proposals
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * @param documentOffset an offset within the document for which
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * completions should be computed
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 * @return an array of completion proposals or <code>null</code> if no
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 * proposals are possible
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 ICompletionProposal[] computeCompletionProposals(IContentAssistSubjectControl contentAssistSubjectControl, int documentOffset);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 * Returns information about possible contexts based on the specified
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 * location within the document that corresponds to the current cursor
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * position within the content assist subject control.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * @param contentAssistSubjectControl the content assist subject control whose
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 * document is used to compute the possible contexts
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 * @param documentOffset an offset within the document for which context
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 * information should be computed
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 * @return an array of context information objects or <code>null</code>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 * if no context could be found
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 IContextInformation[] computeContextInformation(IContentAssistSubjectControl contentAssistSubjectControl, int documentOffset);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 }