Mercurial > projects > dwt-addons
diff dwtx/jface/contentassist/ISubjectControlContentAssistProcessor.d @ 158:25f1f92fa3df
...
author | Frank Benoit <benoit@tionex.de> |
---|---|
date | Tue, 26 Aug 2008 02:46:34 +0200 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/dwtx/jface/contentassist/ISubjectControlContentAssistProcessor.d Tue Aug 26 02:46:34 2008 +0200 @@ -0,0 +1,60 @@ +/******************************************************************************* + * Copyright (c) 2000, 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.contentassist.ISubjectControlContentAssistProcessor; + +import dwt.dwthelper.utils; + +import dwtx.jface.text.contentassist.ICompletionProposal; +import dwtx.jface.text.contentassist.IContentAssistProcessor; +import dwtx.jface.text.contentassist.IContextInformation; +import dwtx.jface.contentassist.IContentAssistSubjectControl; + + +/** + * Extension interface for {@link dwtx.jface.text.contentassist.IContentAssistProcessor} + * which provides the context for the + * {@linkplain dwtx.jface.contentassist.ISubjectControlContentAssistant subject control content assistant}. + * + * @since 3.0 + * @deprecated As of 3.2, replaced by Platform UI's field assist support + */ +public interface ISubjectControlContentAssistProcessor : IContentAssistProcessor { + + /** + * Returns a list of completion proposals based on the specified location + * within the document that corresponds to the current cursor position + * within the text viewer. + * + * @param contentAssistSubjectControl the content assist subject control whose + * document is used to compute the proposals + * @param documentOffset an offset within the document for which + * completions should be computed + * @return an array of completion proposals or <code>null</code> if no + * proposals are possible + */ + ICompletionProposal[] computeCompletionProposals(IContentAssistSubjectControl contentAssistSubjectControl, int documentOffset); + + /** + * Returns information about possible contexts based on the specified + * location within the document that corresponds to the current cursor + * position within the content assist subject control. + * + * @param contentAssistSubjectControl the content assist subject control whose + * document is used to compute the possible contexts + * @param documentOffset an offset within the document for which context + * information should be computed + * @return an array of context information objects or <code>null</code> + * if no context could be found + */ + IContextInformation[] computeContextInformation(IContentAssistSubjectControl contentAssistSubjectControl, int documentOffset); +}