UCommonVisibilitySwitcher

Basic switcher that toggles visibility on its children to only show one widget at a time.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

CommonUI

Header

/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/CommonVisibilitySwitcher.h

Include

#include "CommonVisibilitySwitcher.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Meta=(DisableNativeTick))
class UCommonVisibilitySwitcher : public UOverlay

Remarks

Basic switcher that toggles visibility on its children to only show one widget at a time. Activates visible widget if possible.

Variables

Name Description

Protected variable UProperty Category, EditAnywhere, Meta

int32

 

ActiveWidgetIndex

Protected variable UProperty Category, EditAnywhere

bool

 

bActivateFirstSlotOnAdding

Whether or not to activate the first slot if one is added dynamically.

Protected variable UProperty Category, EditAnywhere

bool

 

bAutoActivateSlot

Whether or not to automatically activate a slot when it becomes visible.

Protected variable

FOnActiveWidget...

 

OnActiveWidgetIndexChangedEvent

Protected variable UProperty Category, EditAnywhere

ESlateVisibilit...

 

ShownVisibility

Functions

Name Description

Public function UFunction BlueprintCallable, Category

void

 

ActivateVisibleSlot()

Public function UFunction BlueprintCallable, Category

void

 

DeactivateVisibleSlot()

Public function UFunction BlueprintCallable, Category

void

 

DecrementActiveWidgetIndex

(
    bool bAllowWrapping
)

Public function Const UFunction BlueprintCallable, Category

UWidget *...

 

GetActiveWidget()

Public function Const UFunction BlueprintCallable, Category

int32

 

GetActiveWidgetIndex()

Public function Const

UWidget *...

 

GetWidgetAtIndex

(
    int32 Index
)

Public function UFunction BlueprintCallable, Category

void

 

IncrementActiveWidgetIndex

(
    bool bAllowWrapping
)

Public function

void

 

MoveChild

(
    int32 CurrentIdx,
    int32 NewIdx
)

Public function Const

FOnActiveWid...

 

OnActiveWidgetIndexChanged()

Protected function

void

 

ResetSlotVisibilities()

Public function UFunction BlueprintCallable, Category

void

 

SetActiveWidget

(
    const UWidget* Widget
)

Public function UFunction BlueprintCallable, Category

void

 

SetActiveWidgetIndex

(
    int32 Index
)

Protected function Virtual

void

 

SetActiveWidgetIndex_Internal

(
    int32 Index,
    bool bBroadcastChange
)

Overridden from UPanelWidget

Name Description

Protected function Virtual Const

UClass *

 

GetSlotClass()

UPanelWidget.

Protected function Virtual

void

 

OnSlotAdded

(
    UPanelSlot* InSlot
)

Protected function Virtual

void

 

OnSlotRemoved

(
    UPanelSlot* InSlot
)

Overridden from UWidget

Name Description

Public function Virtual

const FText

 

GetPaletteCategory()

Gets the palette category of the widget

Public function Virtual

void

 

OnDescendantDeselectedByDesigner

(
    UWidget* DescendantWidget
)

Public function Virtual

void

 

OnDescendantSelectedByDesigner

(
    UWidget* DescendantWidget
)

Protected function Virtual

void

 

OnWidgetRebuilt()

Function called after the underlying SWidget is constructed.

Public function Virtual

void

 

SynchronizeProperties()

Applies all properties to the native widget if possible.

Protected function Virtual Const

void

 

ValidateCompiledDefaults

(
    IWidgetCompilerLog& CompileLog
)

Called at the end of Widget Blueprint compilation.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Typedefs

Name

Description

FOnActiveWidgetIndexChanged

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss