Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > CommonUI > Groups > UCommonButtonGroupBase

Light Theme

Dark Theme

UCommonButtonGroupBase

Manages an arbitrary collection of CommonButton widgets.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UCommonWidgetGroupBase

UCommonButtonGroupBase

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType)
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

	Name	Description
bool	bSelectionRequired	If true, the group will force that a button be selected at all times
TArray< TWeakOb...	Buttons
int32	HoveredButtonIndex
FNativeSimpleBu...	NativeOnButtonBaseClicked
FNativeSimpleBu...	NativeOnButtonBaseDoubleClicked
FNativeSimpleBu...	NativeOnHoveredButtonBaseChanged
FNativeSimpleBu...	NativeOnSelectedButtonBaseChanged
FNativeOnSelect...	NativeOnSelectionCleared
FSimpleButtonBa...	OnButtonBaseClicked
FSimpleButtonBa...	OnButtonBaseDoubleClicked
FSimpleButtonBa...	OnHoveredButtonBaseChanged
FSimpleButtonBa...	OnSelectedButtonBaseChanged
FOnSelectionCle...	OnSelectionCleared
int32	SelectedButtonIndex

Constructors

	Name	Description
	UCommonButtonGroupBase()

Functions

	Name	Description
void	DeselectAll()	Deselects all buttons in the group.
int32	FindButtonIndex ( const UCommonButtonBase* Butto... )	Find the button index of the specified button, if possible
void	ForEach ( TFunctionRef< void... )
UCommonButto...	GetButtonBaseAtIndex ( int32 Index )
int32	GetButtonCount()
int32	GetHoveredButtonIndex()	Get the index of the currently hovered button, if any.
UCommonButto...	GetSelectedButtonBase()
int32	GetSelectedButtonIndex()	Get the index of the currently selected button, if any.
bool	GetSelectionRequired()
bool	HasAnyButtons()
void	OnButtonBaseHovered ( UCommonButtonBase* BaseButton )
void	OnButtonBaseUnhovered ( UCommonButtonBase* BaseButton )
void	OnHandleButtonBaseClicked ( UCommonButtonBase* BaseButton )
void	OnHandleButtonBaseDoubleClicked ( UCommonButtonBase* BaseButton )
void	OnSelectionStateChangedBase ( UCommonButtonBase* BaseButton, bool bIsSelected )
void	SelectButtonAtIndex ( int32 ButtonIndex )	Selects a button at a specific index in the group. Clears all selection if given an invalid index.
void	SelectNextButton ( bool bAllowWrap )	Selects the next button in the group
void	SelectNextButtonRecursive ( int32 SelectionIndex, bool bAllowWrap )
void	SelectPrevButtonRecursive ( int32 SelectionIndex, bool bAllowWrap )
void	SelectPreviousButton ( bool bAllowWrap )	Selects the previous button in the group
void	SetSelectionRequired ( bool bRequireSelection )	Sets whether the group should always have a button selected.

Overridden from UCommonWidgetGroupBase

		Name	Description
	TSubclassOf<...	GetWidgetType()
	void	OnRemoveAll()
	void	OnWidgetAdded ( UWidget* NewWidget )
	void	OnWidgetRemoved ( UWidget* OldWidget )

Classes

	Name	Description
	FNativeOnSelectionCleared
	FNativeSimpleButtonBaseGroupDelegate

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

Take our survey

Dismiss