blob: 8b2f7ac5bd44333bd95e8b338539dee1723736cc (
plain)
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
61
62
63
|
// Copyright (c) AlphaSierraPapa for the SharpDevelop Team (for details please see \doc\copyright.txt)
// This code is distributed under the GNU LGPL (for details please see \doc\license.txt)
using System;
namespace Tango.Scripting.Editors.Rendering
{
/// <summary>
/// Abstract base class for generators that produce new visual line elements.
/// </summary>
public abstract class VisualLineElementGenerator
{
/// <summary>
/// Gets the text run construction context.
/// </summary>
protected ITextRunConstructionContext CurrentContext { get; private set; }
/// <summary>
/// Initializes the generator for the <see cref="ITextRunConstructionContext"/>
/// </summary>
public virtual void StartGeneration(ITextRunConstructionContext context)
{
if (context == null)
throw new ArgumentNullException("context");
this.CurrentContext = context;
}
/// <summary>
/// De-initializes the generator.
/// </summary>
public virtual void FinishGeneration()
{
this.CurrentContext = null;
}
/// <summary>
/// Should only be used by VisualLine.ConstructVisualElements.
/// </summary>
internal int cachedInterest;
/// <summary>
/// Gets the first offset >= startOffset where the generator wants to construct an element.
/// Return -1 to signal no interest.
/// </summary>
public abstract int GetFirstInterestedOffset(int startOffset);
/// <summary>
/// Constructs an element at the specified offset.
/// May return null if no element should be constructed.
/// </summary>
/// <remarks>
/// Avoid signalling interest and then building no element by returning null - doing so
/// causes the generated <see cref="VisualLineText"/> elements to be unnecessarily split
/// at the position where you signalled interest.
/// </remarks>
public abstract VisualLineElement ConstructElement(int offset);
}
internal interface IBuiltinElementGenerator
{
void FetchOptions(TextEditorOptions options);
}
}
|
