Navigation
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
- UObjectBase → UObjectBaseUtility → UObject → UCommonWidgetGroupBase → UCommonButtonGroupBase
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCommonButtonGroupBase() |
Groups/CommonButtonGroupBase.h |
Classes
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| NativeOnButtonBaseClicked | FNativeSimpleButtonBaseGroupDelegate | Groups/CommonButtonGroupBase.h |
|
|
| NativeOnButtonBaseDoubleClicked | FNativeSimpleButtonBaseGroupDelegate | Groups/CommonButtonGroupBase.h |
|
|
| NativeOnButtonBaseLockClicked | FNativeSimpleButtonBaseGroupDelegate | Groups/CommonButtonGroupBase.h |
|
|
| NativeOnButtonBaseLockDoubleClicked | FNativeSimpleButtonBaseGroupDelegate | Groups/CommonButtonGroupBase.h |
|
|
| NativeOnHoveredButtonBaseChanged | FNativeSimpleButtonBaseGroupDelegate | Groups/CommonButtonGroupBase.h |
|
|
| NativeOnSelectedButtonBaseChanged | FNativeSimpleButtonBaseGroupDelegate | Groups/CommonButtonGroupBase.h |
|
|
| NativeOnSelectionCleared | FNativeOnSelectionCleared | Groups/CommonButtonGroupBase.h |
|
|
| OnButtonBaseClicked | FSimpleButtonBaseGroupDelegate | Groups/CommonButtonGroupBase.h |
|
|
| OnButtonBaseDoubleClicked | FSimpleButtonBaseGroupDelegate | Groups/CommonButtonGroupBase.h |
|
|
| OnButtonBaseLockClicked | FSimpleButtonBaseGroupDelegate | Groups/CommonButtonGroupBase.h |
|
|
| OnButtonBaseLockDoubleClicked | FSimpleButtonBaseGroupDelegate | Groups/CommonButtonGroupBase.h |
|
|
| OnHoveredButtonBaseChanged | FSimpleButtonBaseGroupDelegate | Groups/CommonButtonGroupBase.h |
|
|
| OnSelectedButtonBaseChanged | FSimpleButtonBaseGroupDelegate | Groups/CommonButtonGroupBase.h |
|
|
| OnSelectionCleared | FOnSelectionCleared | Groups/CommonButtonGroupBase.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DeselectAll() |
Deselects all buttons in the group. | Groups/CommonButtonGroupBase.h |
|
int32 FindButtonIndex
(
const UCommonButtonBase* ButtonToFind |
Find the button index of the specified button, if possible | Groups/CommonButtonGroupBase.h |
|
void ForEach
(
TFunctionRef< void(UCommonButtonBase&, int32)> Functor |
Groups/CommonButtonGroupBase.h | ||
UCommonButtonBase * GetButtonBaseAtIndex
(
int32 Index |
Groups/CommonButtonGroupBase.h |
|
|
int32 GetButtonCount() |
Groups/CommonButtonGroupBase.h |
|
|
int32 GetHoveredButtonIndex() |
Get the index of the currently hovered button, if any. | Groups/CommonButtonGroupBase.h |
|
UCommonButtonBase * GetSelectedButtonBase() |
Groups/CommonButtonGroupBase.h |
|
|
int32 GetSelectedButtonIndex() |
Get the index of the currently selected button, if any. | Groups/CommonButtonGroupBase.h |
|
bool GetSelectionRequired() |
Groups/CommonButtonGroupBase.h | ||
bool HasAnyButtons() |
Groups/CommonButtonGroupBase.h |
|
|
void SelectButtonAtIndex
(
int32 ButtonIndex, |
Selects a button at a specific index in the group. Clears all selection if given an invalid index. | Groups/CommonButtonGroupBase.h |
|
void SelectNextButton
(
bool bAllowWrap |
Selects the next button in the group | Groups/CommonButtonGroupBase.h |
|
void SelectPreviousButton
(
bool bAllowWrap |
Selects the previous button in the group | Groups/CommonButtonGroupBase.h |
|
void SetSelectionRequired
(
bool bRequireSelection |
Sets whether the group should always have a button selected. | Groups/CommonButtonGroupBase.h |
|
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, |
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 |