Interface IFocusedUI

Contains information about UI controls which have focus (and thus block input from other controls).

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface IFocusedUI

Properties

CannotLoseFocus

A list of entities that cannot lose focus. Those will still grab input even if there's a grabbing focus dialog showing. This is useful for debugging tools, for example.

Declaration

IConcurrentHashSet<string> CannotLoseFocus { get; }

Property Value

Type	Description
IConcurrentHashSet<System.String>	The cannot lose focus.

FocusedWindow

Gets the focused window (useful for modal dialogs). If a window has focus then objects outside the window will not be clickable. To make your window focusable, add the IModalWindowComponent and then use GrabFocus/LoseFocus as needed.

Declaration

IEntity FocusedWindow { get; }

Property Value

Type	Description
IEntity	The focused window.

HasKeyboardFocus

Gets or sets the control which receives keyboard events. If there's a control with keyboard focus, then keyboard input should go to that control and not to anywhere else.

Declaration

IEntity HasKeyboardFocus { get; set; }

Property Value

Type	Description
IEntity	The focused text box.