|
129
|
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 dwtx.jface.text.contentassist.IContextInformationPresenter;
|
|
|
14
|
|
|
15 import dwt.dwthelper.utils;
|
|
|
16
|
|
|
17 import dwtx.jface.text.ITextViewer;
|
|
|
18 import dwtx.jface.text.TextPresentation;
|
|
|
19
|
|
|
20
|
|
|
21 /**
|
|
|
22 * A context information presenter determines the presentation
|
|
|
23 * of context information depending on a given document position.
|
|
|
24 * <p>
|
|
|
25 * The interface can be implemented by clients.
|
|
|
26 * </p>
|
|
|
27 *
|
|
|
28 * @since 2.0
|
|
|
29 */
|
|
|
30 public interface IContextInformationPresenter {
|
|
|
31
|
|
|
32 /**
|
|
|
33 * Installs this presenter for the given context information.
|
|
|
34 *
|
|
|
35 * @param info the context information which this presenter should style
|
|
|
36 * @param viewer the text viewer on which the information is presented
|
|
|
37 * @param offset the document offset for which the information has been computed
|
|
|
38 */
|
|
|
39 void install(IContextInformation info, ITextViewer viewer, int offset);
|
|
|
40
|
|
|
41 /**
|
|
|
42 * Updates the given presentation of the given context information
|
|
|
43 * at the given document position. Returns whether update changed the
|
|
|
44 * presentation.
|
|
|
45 *
|
|
|
46 * @param offset the current offset within the document
|
|
|
47 * @param presentation the presentation to be updated
|
|
|
48 * @return <code>true</code> if the given presentation has been changed
|
|
|
49 */
|
|
|
50 bool updatePresentation(int offset, TextPresentation presentation);
|
|
|
51 }
|
