1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
//
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
//
using Microsoft.VisualStudio.Text.Editor;
namespace Microsoft.VisualStudio.Text.Differencing
{
/// <summary>
/// A service for creating <see cref="ICocoaDifferenceViewer"/>s.
/// </summary>
/// <remarks>
/// This is a MEF service to be imported.
/// </remarks>
public interface ICocoaDifferenceViewerFactoryService
{
/// <summary>
/// Create an <see cref="IDifferenceViewer"/> over the given <see cref="IDifferenceBuffer"/>.
/// </summary>
/// <param name="buffer">The difference buffer to display.</param>
/// <param name="parentOptions">The parent of the editor options for the difference viewer (if null, the global options are the parent).</param>
/// <returns>A difference viewer.</returns>
ICocoaDifferenceViewer CreateDifferenceView(IDifferenceBuffer buffer, IEditorOptions parentOptions = null);
/// <summary>
/// Create an <see cref="IDifferenceViewer"/> over the given <see cref="IDifferenceBuffer"/> with the given set of roles.
/// </summary>
/// <param name="buffer">The difference buffer to display.</param>
/// <param name="roles">The text view roles to use for the created views.</param>
/// <param name="parentOptions">The parent of the editor options for the difference viewer (if null, the global options are the parent).</param>
/// <returns>A difference viewer.</returns>
ICocoaDifferenceViewer CreateDifferenceView(IDifferenceBuffer buffer, ITextViewRoleSet roles, IEditorOptions parentOptions = null);
/// <summary>
/// Create an <see cref="IDifferenceViewer"/> over the given <see cref="IDifferenceBuffer"/>, using the given
/// callback to create the individual views (inline, left, and right).
/// </summary>
/// <param name="buffer">The difference buffer to display.</param>
/// <param name="callback">The callback to use to create individual views.</param>
/// <param name="parentOptions">The parent of the editor options for the difference viewer (if null, the global options are the parent).</param>
/// <returns>A difference viewer.</returns>
ICocoaDifferenceViewer CreateDifferenceView(IDifferenceBuffer buffer, CreateTextViewHostCallback callback, IEditorOptions parentOptions = null);
/// <summary>
/// Create an <see cref="IDifferenceViewer"/> over the given <see cref="IDifferenceBuffer"/>, without initializing it.
/// </summary>
/// <returns>A difference viewer.</returns>
/// <remarks>
/// The only legitimate property call on an uninitialized viwer is the VisualElement property.
/// </remarks>
ICocoaDifferenceViewer CreateUninitializedDifferenceView();
/// <summary>
/// If the given text view is owned by a difference viewer, retrieve that difference viewer.
/// </summary>
/// <param name="textView">The view to find the difference viewer for.</param>
/// <returns>A difference viewer, if one exists. Otherwise, <c>null</c>.</returns>
ICocoaDifferenceViewer TryGetViewerForTextView(ITextView textView);
}
}
|
