MouseStepBuilder
Namespace: Hex1b.Input
Assembly: Hex1b.dll
Fluent builder for constructing a mouse binding.
public sealed class MouseStepBuilderInheritance
Object → MouseStepBuilder
Methods
Action(Action, string?)
Binds the action to execute when this mouse event occurs.
Parameters:
Returns: InputBindingsBuilder
public InputBindingsBuilder Action(Action action, string? description = null)Action(Action<InputBindingActionContext>, string?)
Binds a context-aware action to execute when this mouse event occurs.
Parameters:
action(Action<InputBindingActionContext>):description(String):
Returns: InputBindingsBuilder
public InputBindingsBuilder Action(Action<InputBindingActionContext> action, string? description = null)Action(Func<InputBindingActionContext, Task>, string?)
Binds an async context-aware action to execute when this mouse event occurs.
Parameters:
action(Func<InputBindingActionContext, Task>):description(String):
Returns: InputBindingsBuilder
public InputBindingsBuilder Action(Func<InputBindingActionContext, Task> action, string? description = null)Ctrl()
Requires Ctrl modifier. Cannot be combined with Shift modifier.
Returns: MouseStepBuilder
public MouseStepBuilder Ctrl()DoubleClick()
Requires a double-click (two clicks within the system threshold).
Returns: MouseStepBuilder
public MouseStepBuilder DoubleClick()OnRelease()
Binds to mouse up instead of mouse down.
Returns: MouseStepBuilder
public MouseStepBuilder OnRelease()Shift()
Requires Shift modifier. Cannot be combined with Ctrl modifier.
Returns: MouseStepBuilder
public MouseStepBuilder Shift()Triggers(ActionId, Action, string?)
Binds a mouse action and registers it for the specified action ID. The handler is registered in the action registry for future rebinding.
Parameters:
Returns: InputBindingsBuilder
public InputBindingsBuilder Triggers(ActionId actionId, Action action, string? description = null)Triggers(ActionId, Action<InputBindingActionContext>, string?)
Binds a mouse action and registers it for the specified action ID. The handler is registered in the action registry for future rebinding.
Parameters:
actionId(ActionId):action(Action<InputBindingActionContext>):description(String):
Returns: InputBindingsBuilder
public InputBindingsBuilder Triggers(ActionId actionId, Action<InputBindingActionContext> action, string? description = null)Triggers(ActionId, Func<InputBindingActionContext, Task>, string?)
Binds a mouse action and registers it for the specified action ID.
Parameters:
actionId(ActionId):action(Func<InputBindingActionContext, Task>):description(String):
Returns: InputBindingsBuilder
public InputBindingsBuilder Triggers(ActionId actionId, Func<InputBindingActionContext, Task> action, string? description = null)TripleClick()
Requires a triple-click (three clicks within the system threshold).
Returns: MouseStepBuilder
public MouseStepBuilder TripleClick()