WidgetPath.inl

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
class FArrangedChildren;
class FArrangedWidget;
class FWidgetPath;
struct EVisibility;
 
 
template<typename MatchRuleType>
bool FWidgetPath::SearchForWidgetRecursively( const MatchRuleType& MatchRule, const FArrangedWidget& InCandidate, FArrangedChildren& OutReversedPath, EVisibility VisibilityFilter, EWidgetPathSearchPurpose SearchPurpose )
{
    // If we are searching in order to move focus and we want to find a visible widget but the current widget is disabled, we do not want to search through it's children.
    if (SearchPurpose == EWidgetPathSearchPurpose::FocusHandling && VisibilityFilter == EVisibility::Visible && !InCandidate.Widget->IsEnabled())
    {
        return false;
    }
 
    const bool bAllow3DWidgets = true;
    const bool bUpdateVisibilityAttributes = SearchPurpose == EWidgetPathSearchPurpose::FocusHandling ? false : true;
    FArrangedChildren ArrangedChildren(VisibilityFilter, bAllow3DWidgets);
    InCandidate.Widget->ArrangeChildren( InCandidate.Geometry, ArrangedChildren, bUpdateVisibilityAttributes );
 
    for( int32 ChildIndex = 0; ChildIndex < ArrangedChildren.Num(); ++ChildIndex )
    {
        const FArrangedWidget& SomeChild = ArrangedChildren[ChildIndex];
        if ( MatchRule.IsMatch(SomeChild.Widget) )
        {
            OutReversedPath.AddWidget( SomeChild );
            return true;
        }
        else if ( SearchForWidgetRecursively( MatchRule, SomeChild, OutReversedPath, VisibilityFilter, SearchPurpose) )
        {
            OutReversedPath.AddWidget( SomeChild );
            return true;
        }
    }
 
    return false;
}
 
template<typename MatchRuleType>
bool FWidgetPath::SearchForWidgetRecursively_Reverse( const MatchRuleType& MatchRule, const FArrangedWidget& InCandidate, FArrangedChildren& OutReversedPath, EVisibility VisibilityFilter, EWidgetPathSearchPurpose SearchPurpose )
{
    // If we are searching in order to move focus and we want to find a visible widget but the current widget is disabled, we do not want to search through it's children.
    if (SearchPurpose == EWidgetPathSearchPurpose::FocusHandling && VisibilityFilter == EVisibility::Visible && !InCandidate.Widget->IsEnabled())
    {
        return false;
    }
 
    const bool bAllow3DWidgets = true;
    const bool bUpdateVisibilityAttributes = SearchPurpose == EWidgetPathSearchPurpose::FocusHandling ? false : true;
    FArrangedChildren ArrangedChildren(VisibilityFilter, bAllow3DWidgets);
    InCandidate.Widget->ArrangeChildren( InCandidate.Geometry, ArrangedChildren, bUpdateVisibilityAttributes );
 
    for( int32 ChildIndex = ArrangedChildren.Num()-1; ChildIndex >=0 ; --ChildIndex )
    {
        const FArrangedWidget& SomeChild = ArrangedChildren[ChildIndex];
        if ( MatchRule.IsMatch(SomeChild.Widget) )
        {
            OutReversedPath.AddWidget( SomeChild );
            return true;
        }
        else if ( SearchForWidgetRecursively_Reverse( MatchRule, SomeChild, OutReversedPath, VisibilityFilter, SearchPurpose) )
        {
            OutReversedPath.AddWidget( SomeChild );
            return true;
        }
    }
 
    return false;
}