Skip to content

FocusStack

Inherits: Resource

Manages the focus flow using a stack

Description

Keeps track of levels of focus through a stack

Properties

Type Name Default
FocusGroup[] stack []
CustomLogger logger

Methods

Returns Signature
FocusGroup current_focus()
bool is_focused(group: FocusGroup)
bool is_in_stack(group: FocusGroup)
int size()
void push(group: FocusGroup)
FocusGroup pop()
void clear()

Property Descriptions

stack

FocusGroup[] stack = []

Note

There is currently no description for this property. Please help us by contributing one!

logger

CustomLogger logger

Note

There is currently no description for this property. Please help us by contributing one!


Method Descriptions

current_focus()

FocusGroup current_focus()

Returns the currently focused focus group

is_focused()

bool is_focused(group: FocusGroup)

Returns whether or not the given focus group is currently focused

is_in_stack()

bool is_in_stack(group: FocusGroup)

Returns true if the given focus group exists anywhere in the stack

size()

int size()

Current size of the focus stack

push()

void push(group: FocusGroup)

Push the given focus group to the top of the focus stack and call its grab_focus method

pop()

FocusGroup pop()

Remove and return the focus group at the top of the focus stack and call the next focus group's grab_focus method.

clear()

void clear()

Clear the focus stack