Mercurial > projects > dwt2

comparison org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/ICompletionProposalExtension2.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) 2000, 2005 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.text.contentassist.ICompletionProposalExtension2;
14
15 import org.eclipse.jface.text.contentassist.ContentAssistEvent; // packageimport
16 import org.eclipse.jface.text.contentassist.Helper; // packageimport
17 import org.eclipse.jface.text.contentassist.PopupCloser; // packageimport
18 import org.eclipse.jface.text.contentassist.IContentAssistant; // packageimport
19 import org.eclipse.jface.text.contentassist.CompletionProposal; // packageimport
20 import org.eclipse.jface.text.contentassist.ICompletionProposalExtension5; // packageimport
21 import org.eclipse.jface.text.contentassist.IContextInformationValidator; // packageimport
22 import org.eclipse.jface.text.contentassist.IContentAssistListener; // packageimport
23 import org.eclipse.jface.text.contentassist.ICompletionProposalExtension6; // packageimport
24 import org.eclipse.jface.text.contentassist.ICompletionListener; // packageimport
25 import org.eclipse.jface.text.contentassist.IContentAssistantExtension4; // packageimport
26 import org.eclipse.jface.text.contentassist.ContextInformation; // packageimport
27 import org.eclipse.jface.text.contentassist.ICompletionProposalExtension3; // packageimport
28 import org.eclipse.jface.text.contentassist.ContextInformationValidator; // packageimport
29 import org.eclipse.jface.text.contentassist.ICompletionProposal; // packageimport
30 import org.eclipse.jface.text.contentassist.IContentAssistProcessor; // packageimport
31 import org.eclipse.jface.text.contentassist.AdditionalInfoController; // packageimport
32 import org.eclipse.jface.text.contentassist.IContextInformationPresenter; // packageimport
33 import org.eclipse.jface.text.contentassist.ICompletionProposalExtension4; // packageimport
34 import org.eclipse.jface.text.contentassist.ICompletionListenerExtension; // packageimport
35 import org.eclipse.jface.text.contentassist.ContextInformationPopup; // packageimport
36 import org.eclipse.jface.text.contentassist.IContextInformationExtension; // packageimport
37 import org.eclipse.jface.text.contentassist.IContentAssistantExtension2; // packageimport
38 import org.eclipse.jface.text.contentassist.ContentAssistSubjectControlAdapter; // packageimport
39 import org.eclipse.jface.text.contentassist.CompletionProposalPopup; // packageimport
40 import org.eclipse.jface.text.contentassist.ICompletionProposalExtension; // packageimport
41 import org.eclipse.jface.text.contentassist.IContextInformation; // packageimport
42 import org.eclipse.jface.text.contentassist.IContentAssistantExtension3; // packageimport
43 import org.eclipse.jface.text.contentassist.ContentAssistant; // packageimport
44 import org.eclipse.jface.text.contentassist.IContentAssistantExtension; // packageimport
45 import org.eclipse.jface.text.contentassist.JFaceTextMessages; // packageimport
46
47
48 import java.lang.all;
49 import java.util.Set;
50
51 import org.eclipse.jface.text.DocumentEvent;
52 import org.eclipse.jface.text.IDocument;
53 import org.eclipse.jface.text.ITextViewer;
54
55
56 /**
57 * Extends {@link org.eclipse.jface.text.contentassist.ICompletionProposal}
58 * with the following functions:
59 * <ul>
60 * <li>handling of trigger characters with modifiers</li>
61 * <li>visual indication for selection of a proposal</li>
62 * </ul>
63 *
64 * @since 2.1
65 */
66 public interface ICompletionProposalExtension2 {
67
68 /**
69 * Applies the proposed completion to the given document. The insertion
70 * has been triggered by entering the given character with a modifier at the given offset.
71 * This method assumes that {@link #validate(IDocument, int, DocumentEvent)}
72 * returns <code>true</code> if called for <code>offset</code>.
73 *
74 * @param viewer the text viewer into which to insert the proposed completion
75 * @param trigger the trigger to apply the completion
76 * @param stateMask the state mask of the modifiers
77 * @param offset the offset at which the trigger has been activated
78 */
79 void apply(ITextViewer viewer, char trigger, int stateMask, int offset);
80
81 /**
82 * Called when the proposal is selected.
83 *
84 * @param viewer the text viewer.
85 * @param smartToggle the smart toggle key was pressed
86 */
87 void selected(ITextViewer viewer, bool smartToggle);
88
89 /**
90 * Called when the proposal is unselected.
91 *
92 * @param viewer the text viewer.
93 */
94 void unselected(ITextViewer viewer);
95
96 /**
97 * Requests the proposal to be validated with respect to the document event.
98 * If the proposal cannot be validated, the methods returns <code>false</code>.
99 * If the document event was <code>null</code>, only the caret offset was changed, but not the document.
100 *
101 * This method replaces {@link ICompletionProposalExtension#isValidFor(IDocument, int)}
102 *
103 * @param document the document
104 * @param offset the caret offset
105 * @param event the document event, may be <code>null</code>
106 * @return bool
107 */
108 bool validate(IDocument document, int offset, DocumentEvent event);
109
110 }