Skip to content

MouseStepBuilder ​

Namespace: Hex1b.Input

Assembly: Hex1b.dll

Fluent builder for constructing a mouse binding.

csharp
public sealed class MouseStepBuilder

Inheritance ​

Object → MouseStepBuilder

Methods ​

Action(Action, string?) ​

Binds the action to execute when this mouse event occurs.

Parameters:

Returns: InputBindingsBuilder

csharp
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:

Returns: InputBindingsBuilder

csharp
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:

Returns: InputBindingsBuilder

csharp
public InputBindingsBuilder Action(Func<InputBindingActionContext, Task> action, string? description = null)

Ctrl() ​

Requires Ctrl modifier.

Returns: MouseStepBuilder

csharp
public MouseStepBuilder Ctrl()

DoubleClick() ​

Requires a double-click (two clicks within the system threshold).

Returns: MouseStepBuilder

csharp
public MouseStepBuilder DoubleClick()

OnRelease() ​

Binds to mouse up instead of mouse down.

Returns: MouseStepBuilder

csharp
public MouseStepBuilder OnRelease()

OverridesCapture() ​

Marks this binding as overriding input capture. When the owning node has captured input, the binding fires on a matching mouse event whose coordinates fall within the captured node's hit-test bounds — even if a focusable child would otherwise consume the click. Mirrors for keyboard bindings.

Returns: MouseStepBuilder

csharp
public MouseStepBuilder OverridesCapture()

Shift() ​

Requires Shift modifier.

Returns: MouseStepBuilder

csharp
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

csharp
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:

Returns: InputBindingsBuilder

csharp
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:

Returns: InputBindingsBuilder

csharp
public InputBindingsBuilder Triggers(ActionId actionId, Func<InputBindingActionContext, Task> action, string? description = null)

Triggers(ActionId) ​

Completes the binding by aliasing a previously registered action to this mouse trigger. The handler is auto-resolved from the action registry.

Parameters:

  • actionId (ActionId): The action to alias. Must have been previously registered via (typically by the widget's default ConfigureDefaultBindings).

Returns: InputBindingsBuilder

The parent for chaining.

csharp
public InputBindingsBuilder Triggers(ActionId actionId)

TripleClick() ​

Requires a triple-click (three clicks within the system threshold).

Returns: MouseStepBuilder

csharp
public MouseStepBuilder TripleClick()

Released under the MIT License.