1. Epic GamesDeveloper
  3. UCommonButtonGroupBase

UCommonButtonGroupBase

Manages an arbitrary collection of CommonButton widgets.

API > API/Plugins > API/Plugins/CommonUI > API/Plugins/CommonUI/Groups

Inheritance Hierarchy

References

   
Module CommonUI
Header /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/Groups/CommonButtonGroupBase.h
Include #include "Groups/CommonButtonGroupBase.h"

Syntax

UCLASS&40;BlueprintType&41;  
class UCommonButtonGroupBase : public UCommonWidgetGroupBase

Remarks

Manages an arbitrary collection of CommonButton widgets. Ensures that no more (and optionally, no less) than one button in the group is selected at a time

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly bool bSelectionRequired If true, the group will force that a button be selected at all times
Protected variable TArray< TWeakObjectPtr< UCommonButtonBase > > Buttons  
Protected variable int32 HoveredButtonIndex  
Public variable FNativeSimpleButtonBaseGroupDelegate NativeOnButtonBaseClicked  
Public variable FNativeSimpleButtonBaseGroupDelegate NativeOnButtonBaseDoubleClicked  
Public variable FNativeSimpleButtonBaseGroupDelegate NativeOnHoveredButtonBaseChanged  
Public variable FNativeSimpleButtonBaseGroupDelegate NativeOnSelectedButtonBaseChanged  
Public variable FNativeOnSelectionCleared NativeOnSelectionCleared  
Public variable UProperty BlueprintAssignable FSimpleButtonBaseGroupDelegate OnButtonBaseClicked  
Public variable UProperty BlueprintAssignable FSimpleButtonBaseGroupDelegate OnButtonBaseDoubleClicked  
Public variable UProperty BlueprintAssignable FSimpleButtonBaseGroupDelegate OnHoveredButtonBaseChanged  
Public variable UProperty BlueprintAssignable FSimpleButtonBaseGroupDelegate OnSelectedButtonBaseChanged  
Public variable UProperty BlueprintAssignable FOnSelectionCleared OnSelectionCleared  
Protected variable int32 SelectedButtonIndex  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void Deselects all buttons in the group.
Public function Const UFunction BlueprintCallable, Category int32

FindButtonIndex ( const UCommonButtonBase* ButtonToFind
)

 Find the button index of the specified button, if possible
Public function void

ForEach ( TFunctionRef< void(UCommonButtonBase&, int32)> Functor
)

  
Public function Const UFunction BlueprintCallable, Category UCommonButtonBase *

GetButtonBaseAtIndex ( int32 Index
)

  
Public function Const UFunction BlueprintCallable, Category int32  
Public function Const UFunction BlueprintCallable, BlueprintPure, Category int32 Get the index of the currently hovered button, if any.
Public function Const UFunction BlueprintCallable, Category UCommonButtonBase *  
Public function Const UFunction BlueprintCallable, BlueprintPure, Category int32 Get the index of the currently selected button, if any.
Public function Const bool  
Public function Const UFunction BlueprintCallable, Category bool  
Protected function Virtual UFunction void  
Protected function Virtual UFunction void  
Protected function Virtual UFunction void  
Protected function Virtual UFunction void  
Protected function Virtual UFunction void

OnSelectionStateChangedBase ( UCommonButtonBase* BaseButton,
bool bIsSelected
)

  
Public function UFunction BlueprintCallable, Category void

SelectButtonAtIndex ( int32 ButtonIndex,
const bool bAllowSound
)

 Selects a button at a specific index in the group. Clears all selection if given an invalid index.
Public function UFunction BlueprintCallable, Category void

SelectNextButton ( bool bAllowWrap
)

 Selects the next button in the group
Public function UFunction BlueprintCallable, Category void

SelectPreviousButton ( bool bAllowWrap
)

 Selects the previous button in the group
Public function UFunction BlueprintCallable, Category void

SetSelectionRequired ( bool bRequireSelection
)

 Sets whether the group should always have a button selected.

Overridden from UCommonWidgetGroupBase

  Type Name Description
Public function Virtual Const TSubclassOf< UWidget >  
Protected function Virtual void  
Protected function Virtual void

OnWidgetAdded ( UWidget* NewWidget
)

  
Protected function Virtual void

OnWidgetRemoved ( UWidget* OldWidget
)

  

Classes

  Type Name Description
Public class FNativeOnSelectionCleared    
Public class FNativeSimpleButtonBaseGroupDelegate    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page