FWeakWidgetPath

Just like a WidgetPath, but uses weak pointers and does not store geometry.

Choose your operating system:

Windows

macOS

Linux

References

Module

SlateCore

Header

/Engine/Source/Runtime/SlateCore/Public/Layout/WidgetPath.h

Include

#include "Layout/WidgetPath.h"

Syntax

class FWeakWidgetPath

Remarks

Just like a WidgetPath, but uses weak pointers and does not store geometry.

Variables

Name Description

Public variable

TArray< TWeakPt...

 

Widgets

Public variable

TWeakPtr< SWind...

 

Window

Constructors

Name Description

Public function

FWeakWidgetPath

(
    const FWidgetPath& InWidgetPath
)

Construct a weak widget path from a widget path. Defaults to an invalid path.

Functions

Name Description

Public function Const

bool

 

ContainsWidget

(
    const SWidget* WidgetToFind
)

Public function Const

TWeakPtr< SW...

 

GetLastWidget()

Get the last (leaf-most) widget in this path; assumes path is valid

Public function Const

bool

 

IsValid()

A valid path has at least one widget in it

Public function Const

FWidgetPath

 

ToNextFocusedPath

(
    EUINavigation NavigationType
)

Public function Const

FWidgetPath

 

ToNextFocusedPath

(
    EUINavigation NavigationType,
    const FNavigationReply& Navigation...,
    const FArrangedWidget& RuleWidget
)

Public function Const

FWidgetPath

 

ToWidgetPath

(
    EInterruptedPathHandling::Type Inte...,
    const FPointerEvent* PointerEv...,
    const EVisibility VisibilityFilter
)

Make a non-weak WidgetPath out of this WeakWidgetPath.

Public function Const

EPathResolut...

 

ToWidgetPath

(
    FWidgetPath& WidgetPath,
    EInterruptedPathHandling::Type Inte...,
    const FPointerEvent* PointerEv...,
    const EVisibility VisibilityFilter
)

Make a non-weak WidgetPath out of this WeakWidgetPath.

Public function Const

TSharedRef< ...

 

ToWidgetPathRef

(
    EInterruptedPathHandling::Type Inte...,
    const FPointerEvent* PointerEv...,
    const EVisibility VisibilityFilter
)

Make a non-weak WidgetPath out of this WeakWidgetPath.

Classes

Name

Description

Public struct

EInterruptedPathHandling

Should interrupted paths truncate or return an invalid path?

Public struct

EPathResolutionResult

Deprecated Functions

Name Description

Public function Const

bool

 

ContainsWidget

(
    const TSharedRef< const SWidget >&...
)

ContainsWidget that takes a shared ptr is deprecated.