Interface IPluginHotkeyRegistration

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

A live hotkey registration returned by Register(string, string, PluginKeyChord, Action).

public interface IPluginHotkeyRegistration : IDisposable

Inherited Members

IDisposable.Dispose()

Properties

EffectiveChord

The chord actually bound: the caller's default unless a stored user override replaced it at registration time.

PluginKeyChord EffectiveChord { get; }

Property Value

PluginKeyChord

IsBound

False when the requested chord collided with an already-bound client action or another plugin's hotkey and the registration was refused; the handler will never fire.

bool IsBound { get; }

Property Value

bool

Methods

Rebind(PluginKeyChord)

Rebinds this registration to a new chord, persisting it as a user override under this hotkey's scoped id so it survives across sessions. Re-resolves immediately if the host's keyboard/dispatcher are already up; a host with nothing to bind to (headless) treats this as a no-op and IsBound stays false.

void Rebind(PluginKeyChord chord)

Parameters

chord PluginKeyChord