UCommonButtonInternalBase

Custom [UButton](API\Runtime\UMG\Components\UButton) override that allows us to disable clicking without disabling the widget entirely

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

CommonUI

Header

/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/CommonButtonBase.h

Include

#include "CommonButtonBase.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Experimental)
class UCommonButtonInternalBase : public UButton

Remarks

Custom UButton override that allows us to disable clicking without disabling the widget entirely

Variables

Name Description

Protected variable UProperty

bool

 

bButtonEnabled

If true, this button is enabled.

Protected variable UProperty

bool

 

bInteractionEnabled

If true, this button can be interacted with it normally.

Public variable

FOnButtonDouble...

 

HandleDoubleClicked

Called when the button is clicked

Protected variable UProperty

int32

 

MinHeight

The minimum height of the button

Protected variable UProperty

int32

 

MinWidth

The minimum width of the button

Protected variable

TSharedPtr< SBo...

 

MyBox

Cached pointer to the underlying slate button owned by this UWidget

Protected variable

TSharedPtr< cla...

 

MyCommonButton

Cached pointer to the underlying slate button owned by this UWidget

Public variable UProperty Category BlueprintAssignable

FOnButtonClicke...

 

OnDoubleClicked

Called when the button is clicked

Public variable

FSimpleDelegate

 

OnReceivedFocus

Called when the button receives focus

Constructors

Name Description

Public function

UCommonButtonInternalBase

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

bool

 

IsPressed()

Public function

void

 

SetButtonEnabled

(
    bool bInIsButtonEnabled
)

Public function

void

 

SetButtonFocusable

(
    bool bInIsButtonFocusable
)

Updates the IsFocusable flag and updates the bIsFocusable flag of the underlying slate button widget

Public function

void

 

SetInteractionEnabled

(
    bool bInIsInteractionEnabled
)

Public function

void

 

SetMinDesiredHeight

(
    int32 InMinHeight
)

Public function

void

 

SetMinDesiredWidth

(
    int32 InMinWidth
)

Protected function Virtual

FReply

 

SlateHandleClickedOverride()

Protected function Virtual

FReply

 

SlateHandleDoubleClicked()

Protected function

void

 

SlateHandleOnReceivedFocus()

Called when internal slate button receives focus; Fires OnReceivedFocus

Protected function Virtual

void

 

SlateHandlePressedOverride()

Protected function Virtual

void

 

SlateHandleReleasedOverride()

Overridden from UWidget

Name Description

Public function Virtual Const

bool

 

IsHovered()

Returns true if the widget is currently being hovered by a pointer device

Protected function Virtual

TSharedRef< ...

 

RebuildWidget()

Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Overridden from UVisual

Name Description

Protected function Virtual

void

 

ReleaseSlateResources

(
    bool bReleaseChildren
)

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