Skip to main content

CommandKeys class

Namespace: Arlecchino.Commands · Assembly: Arlecchino

The keys that reach commands, and the half-typed chord in between two of them.

public sealed class CommandKeys

Properties​

MemberSummary
IsWaitingWhether a chord has been started, so the next key belongs to it and nothing else.

Methods​

MemberSummary
Hints()Every key that would finish the chord being typed, under the name of that key alone. This is what a leader is grouped for: the second key is looked up rather than remembered.

Properties in detail​

IsWaiting​

public bool IsWaiting { get; }

Whether a chord has been started, so the next key belongs to it and nothing else.

Type bool

Methods in detail​

Hints()​

public ValueTuple<string, string>[] Hints();

Every key that would finish the chord being typed, under the name of that key alone. This is what a leader is grouped for: the second key is looked up rather than remembered.

Returns ValueTuple<T1, T2><string, string>[] — The keys behind the leader, or nothing when no chord is waiting.