Interface IBindInput

Namespace

RichHudFramework.UI

Assembly

RichHudClient.dll

Allows a UI element to respond to arbitrary custom control binds (IBind).

public interface IBindInput : IFocusableElement, IEnumerable<IBindEventProxy>, IEnumerable

Inherited Members

FocusHandler

GetEnumerator()

Properties

InputFilter

If set, the input groups indicated by the flags will be temporarily blocked until the BintInputElement is disabled.

Uses RequestTempBlacklist(SeBlacklistModes).

SeBlacklistModes InputFilter { get; set; }

Property Value

SeBlacklistModes

IsFocusRequired

If true, bind events will only fire when the parent element has input focus. Default = false.

Only applies if the parent/InputOwner implements IFocusableElement.

bool IsFocusRequired { get; set; }

Property Value

bool

this[IBind]

Retrieves the event proxy (press/release events) for a specific bind on this UI element

IBindEventProxy this[IBind bind] { get; }

Parameters

bind IBind

Property Value

IBindEventProxy

Methods

Add(IBind, EventHandler, EventHandler, EventHandler)

Adds a new bind to the input element if it hasn't been added before, and/or registers the given event handlers to it.

void Add(IBind bind, EventHandler NewPressed = null, EventHandler PressedAndHeld = null, EventHandler Released = null)

Parameters

bind IBind

NewPressed EventHandler

PressedAndHeld EventHandler

Released EventHandler

GetHasBind(IBind)

Returns true if the given bind is actively used and handled by this element

bool GetHasBind(IBind bind)

Parameters

bind IBind

Returns

bool