diff options
Diffstat (limited to 'src/Editor/Text/Def/TextUI/Adornments/IXplatAdornmentLayer.cs')
| -rw-r--r-- | src/Editor/Text/Def/TextUI/Adornments/IXplatAdornmentLayer.cs | 107 |
1 files changed, 107 insertions, 0 deletions
diff --git a/src/Editor/Text/Def/TextUI/Adornments/IXplatAdornmentLayer.cs b/src/Editor/Text/Def/TextUI/Adornments/IXplatAdornmentLayer.cs new file mode 100644 index 0000000..aebe3a2 --- /dev/null +++ b/src/Editor/Text/Def/TextUI/Adornments/IXplatAdornmentLayer.cs @@ -0,0 +1,107 @@ +// +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for license information. +// +namespace Microsoft.VisualStudio.Text.Editor +{ + using System; + using System.Collections.ObjectModel; + using System.Windows; + + /// <summary> + /// Represents an adornment layer. + /// </summary> + public interface IXPlatAdornmentLayer + { + /// <summary> + /// Adds a <see cref="object"/> to the layer. + /// </summary> + /// <param name="behavior">The positioning behavior of <paramref name="adornment"/>.</param> + /// <param name="visualSpan">The span with which <paramref name="adornment"/> is associated.</param> + /// <param name="tag">The tag associated with <paramref name="adornment"/>.</param> + /// <param name="adornment">The <see cref="object"/> to add to the view.</param> + /// <param name="removedCallback">The delegate to call when <paramref name="adornment"/> + /// is removed from the view.</param> + /// <returns><c>true</c> if <paramref name="adornment"/> was added to the layer, otherwise <c>false</c>. + /// <paramref name="visualSpan"/> does not intersect the text that is visible in the view.</returns> + /// <remarks> + /// <para>If <paramref name="visualSpan"/> is specified, then the adornment will be removed whenever any line that crosses <paramref name="visualSpan"/> is formatted.</para> + /// <para>If <paramref name="visualSpan"/> has a length of zero, then it will be invalidated when the line that contains the following character is invalidated + /// (or the last line, if the visual span is at the end of the buffer).</para> + /// </remarks> + bool AddAdornment(XPlatAdornmentPositioningBehavior behavior, SnapshotSpan? visualSpan, + object tag, object adornment, XPlatAdornmentRemovedCallback removedCallback); + + /// <summary> + /// Adds a XPlatAdornmentPositioningBehavior.TextRelative <see cref="object"/> to the layer. + /// </summary> + /// <param name="visualSpan">The span with which <paramref name="adornment"/> is associated.</param> + /// <param name="tag">The tag associated with <paramref name="adornment"/>.</param> + /// <param name="adornment">The <see cref="object"/> to add to the view.</param> + /// <returns><c>true</c> if <paramref name="adornment"/> was added to the layer, otherwise <c>false</c>. + /// <paramref name="visualSpan"/> does not intersect the text that is visible in the view.</returns> + /// <remarks>This is equivalent to calling AddElement(XPlatAdornmentPositioningBehavior.TextRelative, + /// visualSpan, tag, adornment, null);</remarks> + /// <remarks> + /// <para>The adornment is removed when any line that crosses <paramref name="visualSpan"/> is formatted.</para> + /// <para>If <paramref name="visualSpan"/> has a length of zero, then it will be invalidated when the line that contains the following character is invalidated + /// (or the last line, if the visualSpan is at the end of the buffer).</para> + /// </remarks> + bool AddAdornment(SnapshotSpan visualSpan, object tag, object adornment); + + /// <summary> + /// Removes a specific <see cref="object"/>. + /// </summary> + /// <param name="adornment"><see cref="object"/> to remove.</param> + void RemoveAdornment(object adornment); + + /// <summary> + /// Removes all <see cref="object"/> objects associated with a particular tag. + /// </summary> + /// <param name="tag">The tag to use to remove <see cref="object"/>s.</param> + void RemoveAdornmentsByTag(object tag); + + /// <summary> + /// Removes all adornments with visual spans that overlap the given visual span. + /// Any adornments without specified visual spans are ignored. + /// </summary> + /// <param name="visualSpan">The visual span to check for overlap with adornments.</param> + void RemoveAdornmentsByVisualSpan(SnapshotSpan visualSpan); + + /// <summary> + /// Removes all adornments for which the given predicate returns <c>true</c>. + /// </summary> + /// <param name="match">The predicate that will be called for each adornment</param> + void RemoveMatchingAdornments(Predicate<IXPlatAdornmentLayerElement> match); + + /// <summary> + /// Removes all adornments with visual spans for which the given predicate returns <c>true</c>. + /// Any adornments without specified visual spans and tag are ignored. + /// </summary> + /// <param name="visualSpan">The visual span to check for overlap with adornments.</param> + /// <param name="match">The predicate that will be called for each adornment</param> + void RemoveMatchingAdornments(SnapshotSpan visualSpan, Predicate<IXPlatAdornmentLayerElement> match); + + /// <summary> + /// Removes all <see cref="object"/> objects in the layer. + /// </summary> + void RemoveAllAdornments(); + + /// <summary> + /// Determines whether this layer is empty, that is, it does not contain any adornments. + /// </summary> + bool IsEmpty { get; } + + /// <summary> + /// Gets or sets the opacity factor applied to the entire adornment layer when it is rendered in the user interface. + /// </summary> + double Opacity { get; set; } + + /// <summary> + /// Gets a collection of the adornments and their associated data in the layer. + /// </summary> + ReadOnlyCollection<IXPlatAdornmentLayerElement> Elements { get; } + + object VisualElement { get; } + } +} |