1. Epic GamesDeveloper
  3. UCommonButtonGroupBase

UCommonButtonGroupBase

Manages an arbitrary collection of CommonButton widgets.

API > API/Plugins > API/Plugins/CommonUI

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

   
Name UCommonButtonGroupBase
Type class
Header File /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/Groups/CommonButtonGroupBase.h
Include Path #include "Groups/CommonButtonGroupBase.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UCommonButtonGroupBase : public UCommonWidgetGroupBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCommonButtonGroupBase()

   Groups/CommonButtonGroupBase.h  

Classes

Name Remarks
FNativeOnSelectionCleared  
FNativeSimpleButtonBaseGroupDelegate  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
NativeOnButtonBaseClicked FNativeSimpleButtonBaseGroupDelegate   Groups/CommonButtonGroupBase.h
  • BlueprintAssignable
NativeOnButtonBaseDoubleClicked FNativeSimpleButtonBaseGroupDelegate   Groups/CommonButtonGroupBase.h
  • BlueprintAssignable
NativeOnButtonBaseLockClicked FNativeSimpleButtonBaseGroupDelegate   Groups/CommonButtonGroupBase.h
  • BlueprintAssignable
NativeOnButtonBaseLockDoubleClicked FNativeSimpleButtonBaseGroupDelegate   Groups/CommonButtonGroupBase.h
  • BlueprintAssignable
NativeOnHoveredButtonBaseChanged FNativeSimpleButtonBaseGroupDelegate   Groups/CommonButtonGroupBase.h
  • BlueprintAssignable
NativeOnSelectedButtonBaseChanged FNativeSimpleButtonBaseGroupDelegate   Groups/CommonButtonGroupBase.h
  • BlueprintAssignable
NativeOnSelectionCleared FNativeOnSelectionCleared   Groups/CommonButtonGroupBase.h
  • BlueprintAssignable
OnButtonBaseClicked FSimpleButtonBaseGroupDelegate   Groups/CommonButtonGroupBase.h
  • BlueprintAssignable
OnButtonBaseDoubleClicked FSimpleButtonBaseGroupDelegate   Groups/CommonButtonGroupBase.h
  • BlueprintAssignable
OnButtonBaseLockClicked FSimpleButtonBaseGroupDelegate   Groups/CommonButtonGroupBase.h
  • BlueprintAssignable
OnButtonBaseLockDoubleClicked FSimpleButtonBaseGroupDelegate   Groups/CommonButtonGroupBase.h
  • BlueprintAssignable
OnHoveredButtonBaseChanged FSimpleButtonBaseGroupDelegate   Groups/CommonButtonGroupBase.h
  • BlueprintAssignable
OnSelectedButtonBaseChanged FSimpleButtonBaseGroupDelegate   Groups/CommonButtonGroupBase.h
  • BlueprintAssignable
OnSelectionCleared FOnSelectionCleared   Groups/CommonButtonGroupBase.h
  • BlueprintAssignable

Functions

Public

Name Remarks Include Path Unreal Specifiers

void DeselectAll()

 Deselects all buttons in the group. Groups/CommonButtonGroupBase.h
  • BlueprintCallable
  • Category=BaseButtonGroup

int32 FindButtonIndex ( const UCommonButtonBase* ButtonToFind
) const

 Find the button index of the specified button, if possible Groups/CommonButtonGroupBase.h
  • BlueprintCallable
  • Category=BaseButtonGroup

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

   Groups/CommonButtonGroupBase.h  

UCommonButtonBase * GetButtonBaseAtIndex ( int32 Index
) const

   Groups/CommonButtonGroupBase.h
  • BlueprintCallable
  • Category=BaseButtonGroup

int32 GetButtonCount()

   Groups/CommonButtonGroupBase.h
  • BlueprintCallable
  • Category=BaseButtonGroup

int32 GetHoveredButtonIndex()

 Get the index of the currently hovered button, if any. Groups/CommonButtonGroupBase.h
  • BlueprintCallable
  • BlueprintPure
  • Category=BaseButtonGroup

UCommonButtonBase * GetSelectedButtonBase()

   Groups/CommonButtonGroupBase.h
  • BlueprintCallable
  • Category=BaseButtonGroup

int32 GetSelectedButtonIndex()

 Get the index of the currently selected button, if any. Groups/CommonButtonGroupBase.h
  • BlueprintCallable
  • BlueprintPure
  • Category=BaseButtonGroup

bool GetSelectionRequired()

   Groups/CommonButtonGroupBase.h  

bool HasAnyButtons()

   Groups/CommonButtonGroupBase.h
  • BlueprintCallable
  • Category=BaseButtonGroup

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. Groups/CommonButtonGroupBase.h
  • BlueprintCallable
  • Category=BaseButtonGroup

void SelectNextButton ( bool bAllowWrap
)

 Selects the next button in the group Groups/CommonButtonGroupBase.h
  • BlueprintCallable
  • Category=BaseButtonGroup

void SelectPreviousButton ( bool bAllowWrap
)

 Selects the previous button in the group Groups/CommonButtonGroupBase.h
  • BlueprintCallable
  • Category=BaseButtonGroup

void SetSelectionRequired ( bool bRequireSelection
)

 Sets whether the group should always have a button selected. Groups/CommonButtonGroupBase.h
  • BlueprintCallable
  • Category=BaseButtonGroup

Overridden from UCommonWidgetGroupBase

Name Remarks Include Path Unreal Specifiers

virtual TSubclassOf< UWidget > GetWidgetType()

   Groups/CommonButtonGroupBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void OnButtonBaseHovered ( UCommonButtonBase* BaseButton
)

   Groups/CommonButtonGroupBase.h  

virtual void OnButtonBaseUnhovered ( UCommonButtonBase* BaseButton
)

   Groups/CommonButtonGroupBase.h  

virtual void OnHandleButtonBaseClicked ( UCommonButtonBase* BaseButton
)

   Groups/CommonButtonGroupBase.h  

virtual void OnHandleButtonBaseDoubleClicked ( UCommonButtonBase* BaseButton
)

   Groups/CommonButtonGroupBase.h  

virtual void OnHandleButtonBaseLockClicked ( UCommonButtonBase* BaseButton
)

   Groups/CommonButtonGroupBase.h  

virtual void OnHandleButtonBaseLockDoubleClicked ( UCommonButtonBase* BaseButton
)

   Groups/CommonButtonGroupBase.h  

virtual void OnSelectionStateChangedBase ( UCommonButtonBase* BaseButton,
bool bIsSelected
)

   Groups/CommonButtonGroupBase.h  

Overridden from UCommonWidgetGroupBase

Name Remarks Include Path Unreal Specifiers

virtual void OnRemoveAll()

   Groups/CommonButtonGroupBase.h  

virtual void OnWidgetAdded ( UWidget* NewWidget
)

   Groups/CommonButtonGroupBase.h  

virtual void OnWidgetRemoved ( UWidget* OldWidget
)

   Groups/CommonButtonGroupBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page