Interface IModalWindowComponent

Adds the ability for a window to be modal (blocks input from other windows). For example, if you create a "Save Game" dialog, you wouldn't want to be able to open the inventory when the dialog is showing, so you'll make the dialog a modal window, then you can grab focus when the window is shown, and lose focus when the window is closed.

Inherited Members

IComponent.Name

IComponent.Entity

IComponent.RegistrationType

IComponent.Init(IEntity, Type)

IComponent.AfterInit()

System.IDisposable.Dispose()

System.ComponentModel.INotifyPropertyChanged.PropertyChanged

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface IModalWindowComponent : IComponent, IDisposable, INotifyPropertyChanged

Properties

HasFocus

Gets a value indicating whether this IModalWindowComponent has focus.

Declaration

bool HasFocus { get; }

Property Value

Type	Description
System.Boolean	true if has focus; otherwise, false.

Methods

GrabFocus()

Grabs the focus for the window. Use this when opening your window. If a window grabs focus when another window already has focus, the new window will now be focused, and the engine will remember that the old window was focused before, so once the new window loses focus the old window will regain focus.

Declaration

void GrabFocus()

LoseFocus()

Loses the focus for the window, bringing the focus back to the previous focused window (or none, if no windows are focused, which is the default).

Declaration

void LoseFocus()