UCommonButtonGroupBase Class Reference

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. More...

Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from UCommonWidgetGroupBase
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Public Attributes
Variables
FSimpleButtonBaseGroupDelegate	OnHoveredButtonBaseChanged
FOnSelectionCleared	OnSelectionCleared
FSimpleButtonBaseGroupDelegate	OnButtonBaseDoubleClicked
FSimpleButtonBaseGroupDelegate	OnButtonBaseClicked
FSimpleButtonBaseGroupDelegate	OnSelectedButtonBaseChanged
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

BaseButtonGroup
bool	bSelectionRequired
	If true, the group will force that a button be selected at all times.
const UCommonButtonBase	SelectedButtonBase
const int	HoveredButtonIndex
	Get the index of the currently hovered button, if any.
const int	ButtonCount
const int	SelectedButtonIndex
	Get the index of the currently selected button, if any.
int	GetSelectedButtonIndex () const
	Get the index of the currently selected button, if any.
int	FindButtonIndex (const UCommonButtonBase ButtonToFind) const
	Find the button index of the specified button, if possible.
UCommonButtonBase	GetButtonBaseAtIndex (int Index) const
int	GetButtonCount () const
int	GetHoveredButtonIndex () const
	Get the index of the currently hovered button, if any.
UCommonButtonBase	GetSelectedButtonBase () const
void	DeselectAll ()
	Deselects all buttons in the group.
bool	HasAnyButtons () const
void	SelectButtonAtIndex (int ButtonIndex, bool bAllowSound=true)
	Selects a button at a specific index in the group. Clears all selection if given an invalid index.
void	SelectNextButton (bool bAllowWrap=true)
	Selects the next button in the group.
void	SelectPreviousButton (bool bAllowWrap=true)
	Selects the previous button in the group.
void	SetSelectionRequired (bool bRequireSelection)
	Sets whether the group should always have a button selected.

Additional Inherited Members
Public Member Functions inherited from UCommonWidgetGroupBase
void	AddWidgets (TArray< UWidget > Widgets)
void	RemoveAll ()
void	RemoveWidget (UWidget InWidget)
void	AddWidget (UWidget InWidget)
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const

Detailed Description

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.

Member Function Documentation

DeselectAll()

void DeselectAll

(

)

Deselects all buttons in the group.

FindButtonIndex()

int FindButtonIndex

(

const UCommonButtonBase

ButtonToFind

)

const

Find the button index of the specified button, if possible.

Parameters

ButtonToFind

Button to find the index of

Returns

Index of the button in the group. INDEX_NONE if not found

GetButtonBaseAtIndex()

UCommonButtonBase GetButtonBaseAtIndex

(

int

Index

)

const

GetButtonCount()

int GetButtonCount

(

)

const

GetHoveredButtonIndex()

int GetHoveredButtonIndex

(

)

const

Get the index of the currently hovered button, if any.

GetSelectedButtonBase()

UCommonButtonBase GetSelectedButtonBase

(

)

const

GetSelectedButtonIndex()

int GetSelectedButtonIndex

(

)

const

Get the index of the currently selected button, if any.

HasAnyButtons()

bool HasAnyButtons

(

)

const

SelectButtonAtIndex()

void SelectButtonAtIndex	(	int	ButtonIndex,
		bool	bAllowSound = true )

Selects a button at a specific index in the group. Clears all selection if given an invalid index.

Parameters

ButtonIndex	The index of the button in the group to select
bAllowSound	Whether the selected button should play its click sound

SelectNextButton()

void SelectNextButton

(

bool

bAllowWrap = true

)

Selects the next button in the group.

Parameters

bAllowWrap

Whether to wrap to the first button if the last one is currently selected

SelectPreviousButton()

void SelectPreviousButton

(

bool

bAllowWrap = true

)

Selects the previous button in the group.

Parameters

bAllowWrap

Whether to wrap to the first button if the last one is currently selected

SetSelectionRequired()

void SetSelectionRequired

(

bool

bRequireSelection

)

Sets whether the group should always have a button selected.

Parameters

bRequireSelection

True to force the group to always have a button selected. If true and nothing is selected, will select the first entry. If empty, will select the first button added.

StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

bSelectionRequired

bool bSelectionRequired

If true, the group will force that a button be selected at all times.

ButtonCount

const int ButtonCount

HoveredButtonIndex

const int HoveredButtonIndex

Get the index of the currently hovered button, if any.

OnButtonBaseClicked

FSimpleButtonBaseGroupDelegate OnButtonBaseClicked

OnButtonBaseDoubleClicked

FSimpleButtonBaseGroupDelegate OnButtonBaseDoubleClicked

OnHoveredButtonBaseChanged

FSimpleButtonBaseGroupDelegate OnHoveredButtonBaseChanged

OnSelectedButtonBaseChanged

FSimpleButtonBaseGroupDelegate OnSelectedButtonBaseChanged

OnSelectionCleared

FOnSelectionCleared OnSelectionCleared

SelectedButtonBase

const UCommonButtonBase SelectedButtonBase

SelectedButtonIndex

const int SelectedButtonIndex

Get the index of the currently selected button, if any.