FocusGroup
Inherits: Node
Automatically manage focus for Control nodes in a container
Description
FocusGroup connects the focus neighbors of all control nodes in the given parent container.
Properties
Methods
| Returns | Signature |
|---|---|
| void | recalculate_focus() |
| void | grab_focus() |
| bool | is_focused() |
| bool | is_in_focus_stack() |
| Node | find_focusable(nodes: Node[], root: Node = null) |
Property Descriptions
current_focus
Control current_focus
The current focus of the focus group
focus_stack
FocusStack focus_stack
DEPRECATED: Use InputWatcher nodes with FocusSetter to handle back input. Menus with multiple levels of focus groups can be part of a chain of focus
back_action
String back_action = "ogui_east"
The InputEvent that will trigger focusing a parent focus group
wrap_focus
bool wrap_focus = true
Whether or not to wrap around focus chains
focus_neighbor_bottom
FocusGroup focus_neighbor_bottom
Note
There is currently no description for this property. Please help us by contributing one!
focus_neighbor_top
FocusGroup focus_neighbor_top
Note
There is currently no description for this property. Please help us by contributing one!
focus_neighbor_left
FocusGroup focus_neighbor_left
Note
There is currently no description for this property. Please help us by contributing one!
focus_neighbor_right
FocusGroup focus_neighbor_right
Note
There is currently no description for this property. Please help us by contributing one!
neighbor_control
Control neighbor_control
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!
parent
Control parent
Note
There is currently no description for this property. Please help us by contributing one!
Method Descriptions
recalculate_focus()
void recalculate_focus()
Recalculate the focus neighbors of the container's children
grab_focus()
void grab_focus()
Grab focus on the currently focused node in the group and push this group to the top of the focus stack
is_focused()
bool is_focused()
Returns true if this focus group is the currently focus in the focus stack.
is_in_focus_stack()
bool is_in_focus_stack()
Returns true if this focus group is anywhere in the focus stack.
find_focusable()
Node find_focusable(nodes: Node[], root: Node = null)
Note
There is currently no description for this method. Please help us by contributing one!