Skip to content

CopyModeBindingsOptions

Namespace: Hex1b

Assembly: Hex1b.dll

Configuration options for standard copy mode key and mouse bindings. All properties have sensible defaults (vi-style keys + mouse).

csharp
public sealed class CopyModeBindingsOptions

Inheritance

ObjectCopyModeBindingsOptions

Properties

BlockSelectionKeys

Key bindings that start or toggle block/rectangular selection.

Returns: KeyBinding[]

csharp
public KeyBinding[] BlockSelectionKeys { get; set; }

BufferBottomKeys

Key bindings that move the cursor to the bottom of the buffer.

Returns: KeyBinding[]

csharp
public KeyBinding[] BufferBottomKeys { get; set; }

BufferTopKeys

Key bindings that move the cursor to the top of the buffer.

Returns: KeyBinding[]

csharp
public KeyBinding[] BufferTopKeys { get; set; }

CancelKeys

Key bindings that cancel copy mode without copying.

Returns: KeyBinding[]

csharp
public KeyBinding[] CancelKeys { get; set; }

CharacterSelectionKeys

Key bindings that start or toggle character selection.

Returns: KeyBinding[]

csharp
public KeyBinding[] CharacterSelectionKeys { get; set; }

CopyKeys

Key bindings that copy the selection and exit copy mode.

Returns: KeyBinding[]

csharp
public KeyBinding[] CopyKeys { get; set; }

CopyToClipboard

Callback to copy text to the system clipboard. When null (default), the framework automatically uses the Hex1bApp's OSC 52 clipboard support. Set to a custom callback to override clipboard behavior, or set to _ => { } to disable.

Returns: Action<String>

csharp
public Action<string>? CopyToClipboard { get; set; }

CursorDownKeys

Key bindings that move the copy mode cursor down one row.

Returns: KeyBinding[]

csharp
public KeyBinding[] CursorDownKeys { get; set; }

CursorLeftKeys

Key bindings that move the copy mode cursor left one column.

Returns: KeyBinding[]

csharp
public KeyBinding[] CursorLeftKeys { get; set; }

CursorRightKeys

Key bindings that move the copy mode cursor right one column.

Returns: KeyBinding[]

csharp
public KeyBinding[] CursorRightKeys { get; set; }

CursorUpKeys

Key bindings that move the copy mode cursor up one row.

Returns: KeyBinding[]

csharp
public KeyBinding[] CursorUpKeys { get; set; }

EnterKeys

Key bindings that enter copy mode when the terminal is focused.

Returns: KeyBinding[]

csharp
public KeyBinding[] EnterKeys { get; set; }

LineEndKeys

Key bindings that move the copy mode cursor to the end of the current line.

Returns: KeyBinding[]

csharp
public KeyBinding[] LineEndKeys { get; set; }

LineSelectionKeys

Key bindings that start or toggle line selection.

Returns: KeyBinding[]

csharp
public KeyBinding[] LineSelectionKeys { get; set; }

LineStartKeys

Key bindings that move the copy mode cursor to the start of the current line.

Returns: KeyBinding[]

csharp
public KeyBinding[] LineStartKeys { get; set; }

MouseBlockModifier

Mouse modifier for block/rectangular selection mode during drag.

Returns: Hex1bModifiers

csharp
public Hex1bModifiers MouseBlockModifier { get; set; }

MouseCopyButton

Mouse button that copies the selection.

Returns: MouseButton

csharp
public MouseButton MouseCopyButton { get; set; }

MouseEnabled

Whether mouse drag-to-select is enabled.

Returns: Boolean

csharp
public bool MouseEnabled { get; set; }

MouseLineModifier

Mouse modifier for line selection mode during drag.

Returns: Hex1bModifiers

csharp
public Hex1bModifiers MouseLineModifier { get; set; }

PageDownKeys

Key bindings that move the copy mode cursor down one page.

Returns: KeyBinding[]

csharp
public KeyBinding[] PageDownKeys { get; set; }

PageUpKeys

Key bindings that move the copy mode cursor up one page.

Returns: KeyBinding[]

csharp
public KeyBinding[] PageUpKeys { get; set; }

WordBackwardKeys

Key bindings that move the copy mode cursor backward one word.

Returns: KeyBinding[]

csharp
public KeyBinding[] WordBackwardKeys { get; set; }

WordForwardKeys

Key bindings that move the copy mode cursor forward one word.

Returns: KeyBinding[]

csharp
public KeyBinding[] WordForwardKeys { get; set; }

Released under the MIT License.