Mercurial > projects > dwt-addons
diff dwtx/jface/text/contentassist/ICompletionProposalExtension3.d @ 129:eb30df5ca28b
Added JFace Text sources
author | Frank Benoit <benoit@tionex.de> |
---|---|
date | Sat, 23 Aug 2008 19:10:48 +0200 |
parents | |
children | c4fb132a086c |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/dwtx/jface/text/contentassist/ICompletionProposalExtension3.d Sat Aug 23 19:10:48 2008 +0200 @@ -0,0 +1,64 @@ +/******************************************************************************* + * Copyright (c) 2000, 2008 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.text.contentassist.ICompletionProposalExtension3; + +import dwt.dwthelper.utils; + +import dwtx.jface.text.IDocument; +import dwtx.jface.text.IInformationControlCreator; + + +/** + * Extends {@link dwtx.jface.text.contentassist.ICompletionProposal} + * with the following functions: + * <ul> + * <li>provision of a custom information control creator</li> + * <li>provide a custom completion text and offset for prefix completion</li> + * </ul> + * + * @since 3.0 + */ +public interface ICompletionProposalExtension3 { + /** + * Returns the information control creator of this completion proposal. + * + * @return the information control creator, or <code>null</code> if no custom control creator is available + */ + IInformationControlCreator getInformationControlCreator(); + + /** + * Returns the string that would be inserted at the position returned from + * {@link #getPrefixCompletionStart(IDocument, int)} if this proposal was + * applied. If the replacement string cannot be determined, + * <code>null</code> may be returned. + * + * @param document the document that the receiver applies to + * @param completionOffset the offset into <code>document</code> where the + * completion takes place + * @return the replacement string or <code>null</code> if it cannot be + * determined + */ + CharSequence getPrefixCompletionText(IDocument document, int completionOffset); + + /** + * Returns the document offset at which the receiver would insert its + * proposal. + * + * @param document the document that the receiver applies to + * @param completionOffset the offset into <code>document</code> where the + * completion takes place + * @return the offset at which the proposal would insert its proposal + */ + int getPrefixCompletionStart(IDocument document, int completionOffset); + +}