Mercurial > projects > dwt2

comparison org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationHoverExtension.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.source.IAnnotationHoverExtension;
14
15 import org.eclipse.jface.text.source.ISharedTextColors; // packageimport
16 import org.eclipse.jface.text.source.ILineRange; // packageimport
17 import org.eclipse.jface.text.source.IAnnotationPresentation; // packageimport
18 import org.eclipse.jface.text.source.IVerticalRulerInfoExtension; // packageimport
19 import org.eclipse.jface.text.source.ICharacterPairMatcher; // packageimport
20 import org.eclipse.jface.text.source.TextInvocationContext; // packageimport
21 import org.eclipse.jface.text.source.LineChangeHover; // packageimport
22 import org.eclipse.jface.text.source.IChangeRulerColumn; // packageimport
23 import org.eclipse.jface.text.source.IAnnotationMap; // packageimport
24 import org.eclipse.jface.text.source.IAnnotationModelListenerExtension; // packageimport
25 import org.eclipse.jface.text.source.ISourceViewerExtension2; // packageimport
26 import org.eclipse.jface.text.source.IAnnotationHover; // packageimport
27 import org.eclipse.jface.text.source.ContentAssistantFacade; // packageimport
28 import org.eclipse.jface.text.source.IAnnotationAccess; // packageimport
29 import org.eclipse.jface.text.source.IVerticalRulerExtension; // packageimport
30 import org.eclipse.jface.text.source.IVerticalRulerColumn; // packageimport
31 import org.eclipse.jface.text.source.LineNumberRulerColumn; // packageimport
32 import org.eclipse.jface.text.source.MatchingCharacterPainter; // packageimport
33 import org.eclipse.jface.text.source.IAnnotationModelExtension; // packageimport
34 import org.eclipse.jface.text.source.ILineDifferExtension; // packageimport
35 import org.eclipse.jface.text.source.DefaultCharacterPairMatcher; // packageimport
36 import org.eclipse.jface.text.source.LineNumberChangeRulerColumn; // packageimport
37 import org.eclipse.jface.text.source.IAnnotationAccessExtension; // packageimport
38 import org.eclipse.jface.text.source.ISourceViewer; // packageimport
39 import org.eclipse.jface.text.source.AnnotationModel; // packageimport
40 import org.eclipse.jface.text.source.ILineDifferExtension2; // packageimport
41 import org.eclipse.jface.text.source.IAnnotationModelListener; // packageimport
42 import org.eclipse.jface.text.source.IVerticalRuler; // packageimport
43 import org.eclipse.jface.text.source.DefaultAnnotationHover; // packageimport
44 import org.eclipse.jface.text.source.SourceViewer; // packageimport
45 import org.eclipse.jface.text.source.SourceViewerConfiguration; // packageimport
46 import org.eclipse.jface.text.source.AnnotationBarHoverManager; // packageimport
47 import org.eclipse.jface.text.source.CompositeRuler; // packageimport
48 import org.eclipse.jface.text.source.ImageUtilities; // packageimport
49 import org.eclipse.jface.text.source.VisualAnnotationModel; // packageimport
50 import org.eclipse.jface.text.source.IAnnotationModel; // packageimport
51 import org.eclipse.jface.text.source.ISourceViewerExtension3; // packageimport
52 import org.eclipse.jface.text.source.ILineDiffInfo; // packageimport
53 import org.eclipse.jface.text.source.VerticalRulerEvent; // packageimport
54 import org.eclipse.jface.text.source.ChangeRulerColumn; // packageimport
55 import org.eclipse.jface.text.source.ILineDiffer; // packageimport
56 import org.eclipse.jface.text.source.AnnotationModelEvent; // packageimport
57 import org.eclipse.jface.text.source.AnnotationColumn; // packageimport
58 import org.eclipse.jface.text.source.AnnotationRulerColumn; // packageimport
59 import org.eclipse.jface.text.source.AbstractRulerColumn; // packageimport
60 import org.eclipse.jface.text.source.ISourceViewerExtension; // packageimport
61 import org.eclipse.jface.text.source.AnnotationMap; // packageimport
62 import org.eclipse.jface.text.source.IVerticalRulerInfo; // packageimport
63 import org.eclipse.jface.text.source.IAnnotationModelExtension2; // packageimport
64 import org.eclipse.jface.text.source.LineRange; // packageimport
65 import org.eclipse.jface.text.source.IAnnotationAccessExtension2; // packageimport
66 import org.eclipse.jface.text.source.VerticalRuler; // packageimport
67 import org.eclipse.jface.text.source.JFaceTextMessages; // packageimport
68 import org.eclipse.jface.text.source.IOverviewRuler; // packageimport
69 import org.eclipse.jface.text.source.Annotation; // packageimport
70 import org.eclipse.jface.text.source.IVerticalRulerListener; // packageimport
71 import org.eclipse.jface.text.source.ISourceViewerExtension4; // packageimport
72 import org.eclipse.jface.text.source.AnnotationPainter; // packageimport
73 import org.eclipse.jface.text.source.IAnnotationHoverExtension2; // packageimport
74 import org.eclipse.jface.text.source.OverviewRuler; // packageimport
75 import org.eclipse.jface.text.source.OverviewRulerHoverManager; // packageimport
76
77
78 import java.lang.all;
79
80 import org.eclipse.jface.text.IInformationControlCreator;
81
82 /**
83 * Extension interface for {@link org.eclipse.jface.text.source.IAnnotationHover} for
84 * <ul>
85 * <li>providing its own information control creator</li>
86 * <li>providing the range of lines for which the hover for a given line is valid</li>
87 * <li>providing whether the information control can interact with the mouse cursor</li>
88 * </ul>
89 *
90 * @see org.eclipse.jface.text.IInformationControlCreator
91 * @see org.eclipse.jface.text.source.IAnnotationHover
92 * @since 3.0
93 */
94 public interface IAnnotationHoverExtension {
95
96 /**
97 * Returns the hover control creator of this annotation hover.
98 *
99 * @return the hover control creator
100 */
101 IInformationControlCreator getHoverControlCreator();
102
103 /**
104 * Returns whether the provided information control can interact with the mouse cursor. I.e. the
105 * hover must implement custom information control management.
106 *
107 * @return <code>true</code> if the mouse cursor can be handled
108 */
109 bool canHandleMouseCursor();
110
111 /**
112 * Returns the object which should be presented in the a
113 * hover popup window. The information is requested based on
114 * the specified line range.
115 *
116 * @param sourceViewer the source viewer this hover is registered with
117 * @param lineRange the line range for which information is requested
118 * @param visibleNumberOfLines the number of visible lines
119 * @return the requested information or <code>null</code> if no such information exists
120 */
121 Object getHoverInfo(ISourceViewer sourceViewer, ILineRange lineRange, int visibleNumberOfLines);
122
123 /**
124 * Returns the range of lines that include the given line number for which
125 * the same hover information is valid.
126 *
127 * @param viewer the viewer which the hover is queried for
128 * @param lineNumber the line number of the line for which a hover is displayed for
129 * @return the computed line range or <code>null</code> for no range
130 */
131 ILineRange getHoverLineRange(ISourceViewer viewer, int lineNumber);
132 }