unreal.CommonUILibrary

class unreal.CommonUILibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

Common UILibrary

C++ Source:

• Plugin: CommonUI

• Module: CommonUI

• File: CommonUILibrary.h

classmethod find_parent_widget_implementing_interface(starting_widget, interface) → Widget

Finds the first parent widget implementing the given interface and returns it, or null if no parent could be found.

Parameters:

• starting_widget (Widget)

• interface (type(Class))

Return type:

Widget

classmethod find_parent_widget_of_type(starting_widget, type) → Widget

Finds the first parent widget of the given type and returns it, or null if no parent could be found.

Parameters:

• starting_widget (Widget)

• type (type(Class))

Return type:

Widget

classmethod refresh_focus_if_leafmost_descendant(context_widget) → bool

Request a focus refresh from any widget that is a descendant of the leaf-most activated widget. This should be used to handle asynchronous requests to route focus from outside the leaf-most activatable widget. A very common use case is a visualization or asynchronous widget creation from a plugin-injected widget or a widget otherwise unavailable or cumbersome to access from the leaf-most activatable widget.

Parameters:

context_widget (Widget)

Returns:

Whether or not the request for focus was made

Return type:

bool