IInputConsumer

Description

interface Tinman.Engine.Application.IInputConsumer

Extended by: Component ^abstract
IApplication
IInputConsumerEx
ISceneEntityView
IWidgetGui

Base interface for classes that consume input events (see InputEvent).

Public / Methods

ConsumeInput

public method ConsumeInput → (1)

inputEvent ⁱⁿ : InputEvent: The user input event.
returns → bool: true if the input event has been consumed, false if not.

Consumes the given user input event.

Input events are provided to an IInputConsumer object only if it has the input focus (see InputEventType.FocusGained and InputEventType.FocusLost). Mouse events are provided when the mouse cursor is inside of the input bounds (InputEventType.MouseEnter and InputEventType.MouseLeave). The InputEventType.Closing event can be provided at any time.

InputEventType.FocusGained: gained input focus
Keyboard events:
- InputEventType.Pressed: key has been pressed down.
- InputEventType.Released: key has been released.
- InputEventType.Clicked: key has been clicked.
- InputEventType.Character: a character has been typed.
Mouse events:
1. InputEventType.MouseEnter
2. Mouse events:
3. InputEventType.MouseLeave
InputEventType.FocusLost: lost input focus
InputEventType.Closing: user request to shut down

Mouse cursor coordinates that are provided with InputEvent.MouseCursor refer to the client-area of the enclosing application window.