Class NoOpHotkeyRegistration

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

A registration handle from a host with nothing to bind (headless).

public sealed class NoOpHotkeyRegistration : IPluginHotkeyRegistration, IDisposable

Inheritance

object

NoOpHotkeyRegistration

Implements

IPluginHotkeyRegistration

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

EffectiveChord

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

public PluginKeyChord EffectiveChord { get; }

Property Value

PluginKeyChord

Instance

The shared instance; this type holds no state.

public static NoOpHotkeyRegistration Instance { get; }

Property Value

NoOpHotkeyRegistration

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.

public bool IsBound { get; }

Property Value

bool

Methods

Dispose()

Does nothing; there is no binding to revoke.

public void Dispose()

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.

public void Rebind(PluginKeyChord chord)

Parameters

chord PluginKeyChord