IEditorSession
Namespace: Hex1b.Documents
Assembly: Hex1b.dll
Handle given to implementations for interacting with the editor they are connected to. Enables providers to push overlays, access editor state, and request re-renders.
public interface IEditorSessionProperties
ActiveGutterDecorations
Returns all currently active gutter decorations.
Returns: IReadOnlyList<GutterDecoration>
IReadOnlyList<GutterDecoration> ActiveGutterDecorations { get; }ActiveInlineHints
Returns all currently active inline hints.
Returns: IReadOnlyList<InlineHint>
IReadOnlyList<InlineHint> ActiveInlineHints { get; }ActiveOverlays
Returns all currently active overlays.
Returns: IReadOnlyList<EditorOverlay>
IReadOnlyList<EditorOverlay> ActiveOverlays { get; }ActiveRangeHighlights
Returns all currently active range highlights.
Returns: IReadOnlyList<RangeHighlight>
IReadOnlyList<RangeHighlight> ActiveRangeHighlights { get; }Breadcrumbs
Returns the current breadcrumb data, or null if none set.
Returns: BreadcrumbData
BreadcrumbData? Breadcrumbs { get; }Capabilities
Terminal capabilities for the current session.
Returns: TerminalCapabilities
TerminalCapabilities Capabilities { get; }FoldingRegions
Returns all currently defined folding regions.
Returns: IReadOnlyList<FoldingRegion>
IReadOnlyList<FoldingRegion> FoldingRegions { get; }State
The current editor state (document, cursors, selections).
Returns: EditorState
EditorState State { get; }Methods
ClearGutterDecorations()
Clears all gutter decorations.
void ClearGutterDecorations()ClearInlineHints()
Clears all inline hints.
void ClearInlineHints()ClearRangeHighlights()
Clears all range highlights.
void ClearRangeHighlights()DismissOverlay(string)
Dismisses an overlay by its unique ID.
Parameters:
overlayId(String):
void DismissOverlay(string overlayId)DismissSignaturePanel()
Dismisses the signature help panel.
void DismissSignaturePanel()Invalidate()
Requests the editor to re-render. Call this after asynchronous updates (e.g., when language server results arrive) to ensure decorations are refreshed.
void Invalidate()PushGutterDecorations(IReadOnlyList<GutterDecoration>)
Pushes gutter decorations (icons/markers in the editor margin). Replaces any previously pushed gutter decorations.
Parameters:
decorations(IReadOnlyList<GutterDecoration>):
void PushGutterDecorations(IReadOnlyList<GutterDecoration> decorations)PushInlineHints(IReadOnlyList<InlineHint>)
Pushes inline hints (virtual text rendered inline without modifying the document). Replaces any previously pushed hints.
Parameters:
hints(IReadOnlyList<InlineHint>):
void PushInlineHints(IReadOnlyList<InlineHint> hints)PushOverlay(EditorOverlay)
Pushes a floating overlay anchored to a document position. If an overlay with the same ID already exists, it is replaced.
Parameters:
overlay(EditorOverlay):
void PushOverlay(EditorOverlay overlay)PushRangeHighlights(IReadOnlyList<RangeHighlight>)
Pushes range highlights (temporary background-colored document ranges). Replaces any previously pushed highlights.
Parameters:
highlights(IReadOnlyList<RangeHighlight>):
void PushRangeHighlights(IReadOnlyList<RangeHighlight> highlights)SetBreadcrumbs(BreadcrumbData?)
Sets breadcrumb data (hierarchical document symbols for navigation).
Parameters:
data(BreadcrumbData):
void SetBreadcrumbs(BreadcrumbData? data)SetFoldingRegions(IReadOnlyList<FoldingRegion>)
Sets folding regions (collapsible code regions). Replaces any previously set regions.
Parameters:
regions(IReadOnlyList<FoldingRegion>):
void SetFoldingRegions(IReadOnlyList<FoldingRegion> regions)ShowActionMenuAsync(ActionMenu)
Shows an action menu popup at the specified position. Returns the selected item's ID, or null if dismissed.
Parameters:
menu(ActionMenu):
Returns: Task<String>
Task<string?> ShowActionMenuAsync(ActionMenu menu)ShowSignaturePanel(SignaturePanel)
Shows a signature help panel.
Parameters:
panel(SignaturePanel):
void ShowSignaturePanel(SignaturePanel panel)