UCheckButtonWidget Class Reference

Custom button widget class representing a check button. More...

#include <CheckButtonWidget.h>

Inheritance diagram for UCheckButtonWidget:

Public Member Functions
void	ActivateButtonHighlight ()
void	ActivateButtonPulsationHighlight ()
virtual void	ChangeButtonState (const bool bState) override
	Changes the state of the button .
void	DeactivateButtonHighlight ()
const FText &	GetButtonName ()
	UFUNCTION(BlueprintCallable)
bool	GetState () const
	Gets the state of the button.
ButtonType	GetType () const
virtual void	NativeOnInitialized () override
virtual void	NativePreConstruct () override
void	OnHintActivated (bool Activate)
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable)
void	RefreshWidgetStyle ()
	Refreshes the visual style of the button widget.
void	SetButtonName (const FText &Name)
	UFUNCTION(BlueprintCallable)

Public Attributes
FText	ActiveStep
	UPROPERTY(BlueprintReadWrite)
FText	ActiveSubStep
	UPROPERTY(BlueprintReadWrite)
bool	bWidgetActiveOnStep
	UPROPERTY(BlueprintReadWrite)
UHintManager *	HintManager
	UPROPERTY(BlueprintReadWrite)
FClickEventDelegate	OnClickEventDelegate
	UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = "Delegate")
FClickEventPtrDelegate	OnClickEventPtrDelegate
	UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = "Delegate")
FClickEventSelfPtrDelegate	OnClickEventSelfPtrDelegate
	UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = "Delegate")
UStoryManager *	StoryManager
	UPROPERTY(BlueprintReadWrite)

Protected Attributes
bool	ActivateHighlightOnEachActiveStep = false
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")
bool	bIsPulsationHighlight = false
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")
bool	bIsSelectable = true
	UPROPERTY(EditAnywhere, BlueprintReadWrite)
UBorder *	Border
	UPROPERTY(BlueprintReadOnly, meta = (BindWidget))
UTextBlock *	BtnName
	UPROPERTY(BlueprintReadOnly, meta = (BindWidget))
UButton *	Button
	UPROPERTY(BlueprintReadOnly, meta = (BindWidget))
UBorder *	ButtonBounds
	UPROPERTY(BlueprintReadOnly, meta = (BindWidget))
FLinearColor	ButtonBoundsColor = FLinearColor::Black
	UPROPERTY(EditAnywhere, BlueprintReadWrite)
float	ButtonBoundsWidth = 2.f
	UPROPERTY(EditAnywhere, BlueprintReadWrite)
UBorder *	ButtonHighlight
	UPROPERTY(BlueprintReadOnly, meta = (BindWidget))
UWidgetAnimation *	ButtonHighlightAnimation
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")
FLinearColor	ButtonHighlightColor = FLinearColor(0.25f, 0.6f, 0.0f, 0.f)
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")
float	ButtonHighlightWidth = 0.f
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")
FText	ButtonName = FText::FromString(TEXT("Text"))
	UPROPERTY(EditAnywhere, BlueprintReadWrite)
FLinearColor	ButtonNameColor = FLinearColor::White
	UPROPERTY(EditAnywhere, BlueprintReadWrite)
float	ButtonNameFontSize = 18.f
	UPROPERTY(EditAnywhere, BlueprintReadWrite)
FLinearColor	DefaultButtonColor = FLinearColor(0.91f, 0.22f, 0.0f, 1.0f)
	UPROPERTY(EditAnywhere, BlueprintReadWrite)
FLinearColor	DefaultHoveredButtonColor = FLinearColor(0.25f, 0.6f, 0.0f, 1.0f)
	UPROPERTY(EditAnywhere, BlueprintReadWrite)
TArray< FText >	HighlightActiveSteps
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")
TArray< FText >	HighlightActiveSubSteps
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")
float	HighlightAnimationSpeed = 1.f
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")
USoundBase *	HoverSound
	UPROPERTY(EditAnywhere, BlueprintReadWrite)
FLinearColor	PressedButtonColor = FLinearColor(0.25f, 0.6f, 0.0f, 1.0f)
	UPROPERTY(EditAnywhere, BlueprintReadWrite)
FLinearColor	SelectedButtonColor = FLinearColor(0.25f, 0.6f, 0.0f, 1.0f)
	UPROPERTY(EditAnywhere, BlueprintReadWrite)
FLinearColor	SelectedHoveredButtonColor = FLinearColor(0.25f, 0.6f, 0.0f, 1.0f)
	UPROPERTY(EditAnywhere, BlueprintReadWrite)
USoundBase *	SelectSound
	UPROPERTY(EditAnywhere, BlueprintReadWrite)
ButtonType	Type

Private Member Functions
void	ButtonHovered ()
	UFUNCTION()
void	ButtonReleased ()
	UFUNCTION()
	GENERATED_BODY ()
void	NewStep (FStoryStep NewStep, bool IsForward)
	UFUNCTION()
void	NewSubStep (FStoryStep NewSubStep)
	UFUNCTION()
void	OnPressed ()
	UFUNCTION()
void	OnUnHovered ()
	UFUNCTION()
void	StoryLoaded ()
	UFUNCTION()
void	SwitchButtonColor (const bool bState)
	Switches the button color based on the state.

Private Attributes
bool	bCurrentState

Detailed Description

Custom button widget class representing a check button.

UCLASS()

Definition at line 15 of file CheckButtonWidget.h.

Member Function Documentation

ActivateButtonHighlight()

void UButtonWidget::ActivateButtonHighlight ( )

inherited

Definition at line 116 of file ButtonWidget.cpp.

Here is the caller graph for this function:

ActivateButtonPulsationHighlight()

void UButtonWidget::ActivateButtonPulsationHighlight ( )

inherited

Definition at line 122 of file ButtonWidget.cpp.

Here is the caller graph for this function:

ButtonHovered()

void UButtonWidget::ButtonHovered ( )

privateinherited

UFUNCTION()

Definition at line 188 of file ButtonWidget.cpp.

Here is the caller graph for this function:

ButtonReleased()

void UButtonWidget::ButtonReleased ( )

privateinherited

UFUNCTION()

Definition at line 172 of file ButtonWidget.cpp.

Here is the caller graph for this function:

ChangeButtonState()

void UCheckButtonWidget::ChangeButtonState ( const bool bState )

overridevirtual

Changes the state of the button .

Parameters

bState

The new state of the button (true - selected, false - default).

UFUNCTION(BlueprintCallable)

Reimplemented from UButtonWidget.

Definition at line 12 of file CheckButtonWidget.cpp.

DeactivateButtonHighlight()

void UButtonWidget::DeactivateButtonHighlight ( )

inherited

Definition at line 130 of file ButtonWidget.cpp.

Here is the caller graph for this function:

GENERATED_BODY()

UCheckButtonWidget::GENERATED_BODY ( )

private

GetButtonName()

const FText & UButtonWidget::GetButtonName ( )

inheritedBlueprintCallable

UFUNCTION(BlueprintCallable)

Definition at line 82 of file ButtonWidget.cpp.

GetState()

bool UButtonWidget::GetState ( ) const

inlineinheritedBlueprintCallable

Gets the state of the button.

Returns

Whether button is selected or not.

UFUNCTION(BlueprintCallable)

Definition at line 85 of file ButtonWidget.h.

GetType()

ButtonType UButtonWidget::GetType ( ) const

inlineinherited

Definition at line 87 of file ButtonWidget.h.

NativeOnInitialized()

void UCheckButtonWidget::NativeOnInitialized ( )

overridevirtual

Reimplemented from UButtonWidget.

Definition at line 5 of file CheckButtonWidget.cpp.

NativePreConstruct()

void UButtonWidget::NativePreConstruct ( )

overridevirtualinherited

Definition at line 69 of file ButtonWidget.cpp.

Here is the call graph for this function:

NewStep()

void UButtonWidget::NewStep ( FStoryStep NewStep, bool IsForward )

privateinherited

UFUNCTION()

Definition at line 209 of file ButtonWidget.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

NewSubStep()

void UButtonWidget::NewSubStep ( FStoryStep NewSubStep )

privateinherited

UFUNCTION()

Definition at line 254 of file ButtonWidget.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

OnHintActivated()

void UButtonWidget::OnHintActivated ( bool Activate )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable)

Here is the caller graph for this function:

OnPressed()

void UButtonWidget::OnPressed ( )

privateinherited

UFUNCTION()

Definition at line 204 of file ButtonWidget.cpp.

Here is the caller graph for this function:

OnUnHovered()

void UButtonWidget::OnUnHovered ( )

privateinherited

UFUNCTION()

Definition at line 199 of file ButtonWidget.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

RefreshWidgetStyle()

void UButtonWidget::RefreshWidgetStyle ( )

inherited

Refreshes the visual style of the button widget.

Definition at line 98 of file ButtonWidget.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

SetButtonName()

void UButtonWidget::SetButtonName ( const FText & Name )

inheritedBlueprintCallable

UFUNCTION(BlueprintCallable)

Definition at line 76 of file ButtonWidget.cpp.

Here is the caller graph for this function:

StoryLoaded()

void UButtonWidget::StoryLoaded ( )

privateinherited

UFUNCTION()

Definition at line 300 of file ButtonWidget.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

SwitchButtonColor()

void UButtonWidget::SwitchButtonColor ( const bool bState )

privateinherited

Switches the button color based on the state.

Parameters

bState

Whether button is selected or not.

Definition at line 93 of file ButtonWidget.cpp.

Here is the caller graph for this function:

Member Data Documentation

ActivateHighlightOnEachActiveStep

bool UButtonWidget::ActivateHighlightOnEachActiveStep = false

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")

Definition at line 367 of file ButtonWidget.h.

ActiveStep

FText UButtonWidget::ActiveStep

inheritedBlueprintReadWrite

UPROPERTY(BlueprintReadWrite)

Definition at line 181 of file ButtonWidget.h.

ActiveSubStep

FText UButtonWidget::ActiveSubStep

inheritedBlueprintReadWrite

UPROPERTY(BlueprintReadWrite)

Definition at line 187 of file ButtonWidget.h.

bCurrentState

bool UButtonWidget::bCurrentState

privateinherited

Definition at line 370 of file ButtonWidget.h.

bIsPulsationHighlight

bool UButtonWidget::bIsPulsationHighlight = false

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")

Definition at line 325 of file ButtonWidget.h.

bIsSelectable

bool UButtonWidget::bIsSelectable = true

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite)

Definition at line 309 of file ButtonWidget.h.

Border

UBorder* UCheckButtonWidget::Border

protectedBlueprintReadOnly

UPROPERTY(BlueprintReadOnly, meta = (BindWidget))

Definition at line 28 of file CheckButtonWidget.h.

BtnName

UTextBlock* UButtonWidget::BtnName

protectedinheritedBlueprintReadOnly

UPROPERTY(BlueprintReadOnly, meta = (BindWidget))

Definition at line 218 of file ButtonWidget.h.

Button

UButton* UButtonWidget::Button

protectedinheritedBlueprintReadOnly

UPROPERTY(BlueprintReadOnly, meta = (BindWidget))

Definition at line 212 of file ButtonWidget.h.

ButtonBounds

UBorder* UButtonWidget::ButtonBounds

protectedinheritedBlueprintReadOnly

UPROPERTY(BlueprintReadOnly, meta = (BindWidget))

Definition at line 206 of file ButtonWidget.h.

ButtonBoundsColor

FLinearColor UButtonWidget::ButtonBoundsColor = FLinearColor::Black

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite)

Definition at line 232 of file ButtonWidget.h.

ButtonBoundsWidth

float UButtonWidget::ButtonBoundsWidth = 2.f

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite)

Definition at line 225 of file ButtonWidget.h.

ButtonHighlight

UBorder* UButtonWidget::ButtonHighlight

protectedinheritedBlueprintReadOnly

UPROPERTY(BlueprintReadOnly, meta = (BindWidget))

Definition at line 200 of file ButtonWidget.h.

ButtonHighlightAnimation

UWidgetAnimation* UButtonWidget::ButtonHighlightAnimation

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")

Definition at line 318 of file ButtonWidget.h.

ButtonHighlightColor

FLinearColor UButtonWidget::ButtonHighlightColor = FLinearColor(0.25f, 0.6f, 0.0f, 0.f)

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")

Definition at line 360 of file ButtonWidget.h.

ButtonHighlightWidth

float UButtonWidget::ButtonHighlightWidth = 0.f

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")

Definition at line 353 of file ButtonWidget.h.

ButtonName

FText UButtonWidget::ButtonName = FText::FromString(TEXT("Text"))

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite)

Definition at line 246 of file ButtonWidget.h.

ButtonNameColor

FLinearColor UButtonWidget::ButtonNameColor = FLinearColor::White

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite)

Definition at line 253 of file ButtonWidget.h.

ButtonNameFontSize

float UButtonWidget::ButtonNameFontSize = 18.f

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite)

Definition at line 239 of file ButtonWidget.h.

bWidgetActiveOnStep

bool UButtonWidget::bWidgetActiveOnStep

inheritedBlueprintReadWrite

UPROPERTY(BlueprintReadWrite)

Definition at line 193 of file ButtonWidget.h.

DefaultButtonColor

FLinearColor UButtonWidget::DefaultButtonColor = FLinearColor(0.91f, 0.22f, 0.0f, 1.0f)

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite)

Definition at line 260 of file ButtonWidget.h.

DefaultHoveredButtonColor

FLinearColor UButtonWidget::DefaultHoveredButtonColor = FLinearColor(0.25f, 0.6f, 0.0f, 1.0f)

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite)

Definition at line 274 of file ButtonWidget.h.

HighlightActiveSteps

TArray<FText> UButtonWidget::HighlightActiveSteps

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")

Definition at line 339 of file ButtonWidget.h.

HighlightActiveSubSteps

TArray<FText> UButtonWidget::HighlightActiveSubSteps

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")

Definition at line 346 of file ButtonWidget.h.

HighlightAnimationSpeed

float UButtonWidget::HighlightAnimationSpeed = 1.f

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")

Definition at line 332 of file ButtonWidget.h.

HintManager

UHintManager* UButtonWidget::HintManager

inheritedBlueprintReadWrite

UPROPERTY(BlueprintReadWrite)

Definition at line 169 of file ButtonWidget.h.

HoverSound

USoundBase* UButtonWidget::HoverSound

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite)

Definition at line 302 of file ButtonWidget.h.

OnClickEventDelegate

FClickEventDelegate UButtonWidget::OnClickEventDelegate

inheritedBlueprintCallableBlueprintAssignable

UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = "Delegate")

Definition at line 149 of file ButtonWidget.h.

OnClickEventPtrDelegate

FClickEventPtrDelegate UButtonWidget::OnClickEventPtrDelegate

inheritedBlueprintCallableBlueprintAssignable

UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = "Delegate")

Definition at line 156 of file ButtonWidget.h.

OnClickEventSelfPtrDelegate

FClickEventSelfPtrDelegate UButtonWidget::OnClickEventSelfPtrDelegate

inheritedBlueprintCallableBlueprintAssignable

UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = "Delegate")

Definition at line 163 of file ButtonWidget.h.

PressedButtonColor

FLinearColor UButtonWidget::PressedButtonColor = FLinearColor(0.25f, 0.6f, 0.0f, 1.0f)

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite)

Definition at line 288 of file ButtonWidget.h.

SelectedButtonColor

FLinearColor UButtonWidget::SelectedButtonColor = FLinearColor(0.25f, 0.6f, 0.0f, 1.0f)

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite)

Definition at line 267 of file ButtonWidget.h.

SelectedHoveredButtonColor

FLinearColor UButtonWidget::SelectedHoveredButtonColor = FLinearColor(0.25f, 0.6f, 0.0f, 1.0f)

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite)

Definition at line 281 of file ButtonWidget.h.

SelectSound

USoundBase* UButtonWidget::SelectSound

protectedinheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite)

Definition at line 295 of file ButtonWidget.h.

StoryManager

UStoryManager* UButtonWidget::StoryManager

inheritedBlueprintReadWrite

UPROPERTY(BlueprintReadWrite)

Definition at line 175 of file ButtonWidget.h.

Type

ButtonType UButtonWidget::Type

protectedinherited

Definition at line 311 of file ButtonWidget.h.

---

The documentation for this class was generated from the following files:

• SDKDemo/Plugins/UnrealEngineSDK/PixoCore/Source/PixoCore/Public/UI/CheckButtonWidget.h
• SDKDemo/Plugins/UnrealEngineSDK/PixoCore/Source/PixoCore/Private/UI/CheckButtonWidget.cpp