1. Epic GamesDeveloper
  3. UCommonButtonBase

UCommonButtonBase

Button that disables itself when not active.

API > API/Plugins > API/Plugins/CommonUI

Button that disables itself when not active. Also updates actions for CommonActionWidget if bound to display platform-specific icons.

   
Name UCommonButtonBase
Type class
Header File /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonButtonBase.h
Include Path #include "CommonButtonBase.h"

Syntax

UCLASS (Abstract, Blueprintable, MinimalAPI, ClassGroup=UI,  
       Meta=(Category="Common UI", DisableNativeTick))  
class UCommonButtonBase : public UCommonUserWidget

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UCommonButtonBase ( const FObjectInitializer& ObjectInitializer
)

   CommonButtonBase.h  

Classes

Name Remarks
FCommonButtonEvent  
FOnIsSelectedChanged  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bNavigateToNextWidgetOnDisable uint8 If this button is currently in focus, and is disabled, hidden, or collapsed then focus will be routed to the next available widget CommonButtonBase.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Input
bStyleNoLongerNeedsConversion bool Used to track widgets that were created before changing the default style pointer to null CommonButtonBase.h  
ClickEvent FWidgetEventField   CommonButtonBase.h
  • BlueprintReadOnly
  • FieldNotify
  • Category="Common Button"
ClickMethod TEnumAsByte< EButtonClickMethod::Type > The type of mouse action required by the user to trigger the button's 'Click' CommonButtonBase.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Input
  • Meta=(ExposeOnSpawn=true)
InputPriority int32 This is the priority for the TriggeringInputAction. CommonButtonBase.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Input
  • Meta=(ExposeOnSpawn=true)
PressMethod TEnumAsByte< EButtonPressMethod::Type >   CommonButtonBase.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Input
TouchMethod TEnumAsByte< EButtonTouchMethod::Type >   CommonButtonBase.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Input
TriggeredInputAction FDataTableRowHandle The input action that can be visualized as well as triggered when the user clicks the button. CommonButtonBase.h  
TriggeringEnhancedInputAction TObjectPtr< UInputAction > The enhanced input action that is bound to this button. CommonButtonBase.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Input
  • Meta=(EditCondition="CommonInput.CommonInputSettings.IsEnhancedInputSupportEnabled", EditConditionHides)
TriggeringInputAction FDataTableRowHandle The input action that is bound to this button. CommonButtonBase.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Input
  • Meta=(ExposeOnSpawn=true, RowType="/Script/CommonUI.CommonInputActionDataBase")

Protected

Name Type Remarks Include Path Unreal Specifiers
bButtonEnabled uint8 True if this button is currently enabled CommonButtonBase.h  
bInteractionEnabled uint8 True if interaction with this button is currently enabled CommonButtonBase.h  
bIsPersistentBinding bool DANGER! Be very, very careful with this. CommonButtonBase.h
  • EditAnywhere
  • Category=Input
  • AdvancedDisplay
bSelected uint8 True if this button is currently selected CommonButtonBase.h  
bStopDoubleClickPropagation uint32   CommonButtonBase.h
  • Transient
DisabledStyle FButtonStyle Internally managed and applied style to use when disabled CommonButtonBase.h  
DisabledTooltipText FText   CommonButtonBase.h  
EnabledTooltipText FText   CommonButtonBase.h  
InputModeOverride ECommonInputMode Set this to Game for special cases where an input action needs to be set for an in-game button. CommonButtonBase.h
  • EditAnywhere
  • Category=Input
  • AdvancedDisplay
LockedStyle FButtonStyle Internally managed and applied style to use when locked CommonButtonBase.h  
NormalStyle FButtonStyle Internally managed and applied style to use when not selected CommonButtonBase.h  
OnClickedEvent FCommonButtonEvent   CommonButtonBase.h  
OnDoubleClickedEvent FCommonButtonEvent   CommonButtonBase.h  
OnDragDetectedEvent FOnDragDetected   CommonButtonBase.h  
OnDragEnterEvent FOnDragEnter   CommonButtonBase.h  
OnDragLeaveEvent FOnDragLeave   CommonButtonBase.h  
OnDragOverEvent FOnDragOver   CommonButtonBase.h  
OnDropEvent FOnDrop   CommonButtonBase.h  
OnFocusLostEvent FCommonButtonEvent   CommonButtonBase.h  
OnFocusReceivedEvent FCommonButtonEvent   CommonButtonBase.h  
OnHoveredEvent FCommonButtonEvent   CommonButtonBase.h  
OnIsSelectedChangedEvent FOnIsSelectedChanged   CommonButtonBase.h  
OnLockClickedEvent FCommonButtonEvent   CommonButtonBase.h  
OnLockDoubleClickedEvent FCommonButtonEvent   CommonButtonBase.h  
OnPressedEvent FCommonButtonEvent   CommonButtonBase.h  
OnReleasedEvent FCommonButtonEvent   CommonButtonBase.h  
OnUnhoveredEvent FCommonButtonEvent   CommonButtonBase.h  
RootButton TWeakObjectPtr< class UCommonButtonInternalBase > The actual UButton that we wrap this user widget into. CommonButtonBase.h  
SelectedStyle FButtonStyle Internally managed and applied style to use when selected CommonButtonBase.h  
SingleMaterialStyleMID TObjectPtr< UMaterialInstanceDynamic > The dynamic material instance of the material set by the single material style, if specified. CommonButtonBase.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearSelection()

   CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button"

void DisableButtonWithReason ( const FText& DisabledReason
)

 Disables this button with a reason (use instead of SetIsEnabled) CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void GetCurrentButtonPadding ( FMargin& OutButtonPadding
) const

   CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Getters"

void GetCurrentCustomPadding ( FMargin& OutCustomPadding
) const

   CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Getters"

UCommonTextStyle * GetCurrentTextStyle()

   CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Getters"

TSubclassOf< UCommonTextStyle > GetCurrentTextStyleClass()

   CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Getters"

UInputAction * GetEnhancedInputAction()

 Gets the appropriate enhanced input action that is set CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Getters"

bool GetInputAction ( FDataTableRowHandle& InputActionRow
) const

 Gets the appropriate input action that is set CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Getters"

bool GetIsFocusable()

 Gets the bIsFocusable flag CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Getters"

bool GetLocked()

   CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Getters"

float GetRequiredHoldTime()

 Returns required hold time for performing a triggering action. CommonButtonBase.h
  • BlueprintCallable
  • BlueprintPure
  • Category="Common Button|Getters"

bool GetRequiresHold()

 Returns true if this button has a hold behavior, even if the triggering action is not holdable. CommonButtonBase.h
  • BlueprintCallable
  • BlueprintPure
  • Category="Common Button|Getters"

bool GetSelected()

   CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Getters"

bool GetShouldSelectUponReceivingFocus()

 Get whether the button should become selected upon receiving focus or not CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Getters"

UMaterialInstanceDynamic * GetSingleMaterialStyleMID()

 Returns the dynamic instance of the material being used for this button, if it is using a single material style. CommonButtonBase.h
  • BlueprintCallable
  • BlueprintPure
  • Category="Common Button|Getters"

UCommonButtonStyle * GetStyle()

 @Returns Current button style CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Getters"

const UCommonButtonStyle * GetStyleCDO()

   CommonButtonBase.h  

bool IsInteractionEnabled()

 Is this button currently interactable? (use instead of GetIsEnabled) CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Getters"

bool IsPressed()

 Is this button currently pressed? CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Getters"

FCommonButtonEvent & OnClicked()

   CommonButtonBase.h  

FOnDragDetected & OnCommonButtonDragDetected()

   CommonButtonBase.h  

FOnDragEnter & OnCommonButtonDragEnter()

   CommonButtonBase.h  

FOnDragLeave & OnCommonButtonDragLeave()

   CommonButtonBase.h  

FOnDragOver & OnCommonButtonDragOver()

   CommonButtonBase.h  

FOnDrop & OnCommonButtonDrop()

   CommonButtonBase.h  

FCommonButtonEvent & OnDoubleClicked()

   CommonButtonBase.h  

FCommonButtonEvent & OnFocusLost()

   CommonButtonBase.h  

FCommonButtonEvent & OnFocusReceived()

   CommonButtonBase.h  

FCommonButtonEvent & OnHovered()

   CommonButtonBase.h  

FOnIsSelectedChanged & OnIsSelectedChanged()

   CommonButtonBase.h  

FCommonButtonEvent & OnLockClicked()

   CommonButtonBase.h  

FCommonButtonEvent & OnLockDoubleClicked()

   CommonButtonBase.h  

FCommonButtonEvent & OnPressed()

   CommonButtonBase.h  

FCommonButtonEvent & OnReleased()

   CommonButtonBase.h  

FCommonButtonEvent & OnUnhovered()

   CommonButtonBase.h  

void SetAllowDragDrop ( bool bInAllowDragDrop
)

 Updates the bAllowDragDrop flag on the RootButton CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetClickedSoundOverride ( USoundBase* Sound
)

   CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Sound"

void SetClickMethod ( EButtonClickMethod::Type InClickMethod
)

 Set the click method for mouse interaction CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetHideInputAction ( bool bInHideInputAction
)

   CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetHoveredSoundOverride ( USoundBase* Sound
)

   CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Sound"

void SetInputActionProgressMaterial ( const FSlateBrush& InProgressMaterialBrush,
const FName& InProgressMaterialParam
)

   CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Input"

void SetIsFocusable ( bool bInIsFocusable
)

 Updates the bIsFocusable flag CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetIsInteractableWhenSelected ( bool bInInteractableWhenSelected
)

 Change whether this widget is selectable at all. If false and currently selected, will deselect. CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetIsInteractionEnabled ( bool bInIsInteractionEnabled
)

 Change whether this widget is selectable at all. If false and currently selected, will deselect. CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetIsLocked ( bool bInIsLocked
)

 Change whether this widget is locked. CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetIsSelectable ( bool bInIsSelectable
)

 Change whether this widget is selectable at all. If false and currently selected, will deselect. CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetIsSelected ( bool InSelected,
bool bGiveClickFeedback
)

 Change the selected state manually. CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetIsToggleable ( bool bInIsToggleable
)

 Change whether this widget is toggleable. If toggleable, clicking when selected will deselect. CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetLockedClickedSoundOverride ( USoundBase* Sound
)

   CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Sound"

void SetLockedHoveredSoundOverride ( USoundBase* Sound
)

   CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Sound"

void SetLockedPressedSoundOverride ( USoundBase* Sound
)

   CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Sound"

void SetMaxDimensions ( int32 InMaxWidth,
int32 InMaxHeight
)

 Sets the maximum dimensions of this button CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetMinDimensions ( int32 InMinWidth,
int32 InMinHeight
)

 Sets the minimum dimensions of this button CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetPressedSoundOverride ( USoundBase* Sound
)

   CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Sound"

void SetPressMethod ( EButtonPressMethod::Type InPressMethod
)

 Set the click method for keyboard/gamepad button press interaction CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetRequiresHold ( bool bInRequiresHold
)

 Change whether this button should have a hold behavior even if the triggering action is not holdable. CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetSelectedClickedSoundOverride ( USoundBase* Sound
)

   CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Sound"

void SetSelectedHoveredSoundOverride ( USoundBase* Sound
)

   CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Sound"

void SetSelectedPressedSoundOverride ( USoundBase* Sound
)

   CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Sound"

void SetShouldSelectUponReceivingFocus ( bool bInShouldSelectUponReceivingFocus
)

 Set whether the button should become selected upon receiving focus or not; Only settable for buttons that are selectable CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetShouldUseFallbackDefaultInputAction ( bool bInShouldUseFallbackDefaultInputAction
)

 Change whether this widget should use the fallback default input action. CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetStyle ( TSubclassOf< UCommonButtonStyle > InStyle
)

 Sets the style of this button, rebuilds the internal styling CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetTouchMethod ( EButtonTouchMethod::Type InTouchMethod
)

 Set the click method for touch interaction CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetTriggeredInputAction ( const FDataTableRowHandle& InputActionRow
)

 Updates the current triggered action CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetTriggeringEnhancedInputAction ( UInputAction* InInputAction
)

 Updates the current triggering enhanced input action, requires enhanced input enabled in CommonUI settings CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

void SetTriggeringInputAction ( const FDataTableRowHandle& InputActionRow
)

 Updates the current triggering action CommonButtonBase.h
  • BlueprintCallable
  • Category="Common Button|Setters"

Overridden from UUserWidget

Name Remarks Include Path Unreal Specifiers

virtual bool Initialize()

   CommonButtonBase.h  

virtual void NativeConstruct()

   CommonButtonBase.h  

virtual void NativeDestruct()

   CommonButtonBase.h  

virtual bool NativeIsInteractable()

   CommonButtonBase.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual bool IsHovered()

   CommonButtonBase.h  

virtual void SetIsEnabled ( bool bInIsEnabled
)

   CommonButtonBase.h  

virtual void SetVisibility ( ESlateVisibility InVisibility
)

   CommonButtonBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void BindInputMethodChangedDelegate()

 Helper function to bind to input method change events CommonButtonBase.h  

virtual void BindTriggeringInputActionToClick()

 Associates this button at its priority with the given key CommonButtonBase.h  

void BP_OnClicked()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Clicked")

void BP_OnDeselected()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Deselected")

void BP_OnDisabled()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Disabled")

void BP_OnDoubleClicked()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Double Clicked")

void BP_OnEnabled()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Enabled")

void BP_OnFocusLost()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Unfocused")

void BP_OnFocusReceived()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Focused")

void BP_OnHovered()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Hovered")

void BP_OnInputActionTriggered()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Input Action Triggered")

void BP_OnInputMethodChanged ( ECommonInputType CurrentInputType
)

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Input Method Changed")

void BP_OnLockClicked()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Lock Clicked")

void BP_OnLockDoubleClicked()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Lock Double Clicked")

void BP_OnLockedChanged ( bool bIsLocked
)

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Locked Changed")

void BP_OnPressed()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Pressed")

void BP_OnReleased()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Released")

void BP_OnRequiresHoldChanged()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Requires Hold Changed")

void BP_OnSelected()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Selected")

void BP_OnUnhovered()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Unhovered")

virtual UCommonButtonInternalBase * ConstructInternalButton()

   CommonButtonBase.h  

virtual void ExecuteTriggeredInput()

 @TODO: DarenC - API decision, consider removing CommonButtonBase.h  

virtual bool GetButtonAnalyticInfo ( FString& ButtonName,
FString& ABTestName,
FString& ExtraData
) const

   CommonButtonBase.h  

virtual bool GetConvertInputActionToHold ()

 By default, if bRequiresHold is true, the bound Input Action will be forced to require hold as well. CommonButtonBase.h  

ECommonInputMode GetInputModeOverride()

   CommonButtonBase.h  

virtual void HandleButtonClicked()

 Handler function registered to the underlying button's click. CommonButtonBase.h  

virtual FReply HandleButtonDoubleClicked()

 Handler function registered to the underlying button's double click. CommonButtonBase.h  

virtual FReply HandleButtonDragDetected ( const FGeometry& MyGeometry,
const FPointerEvent& PointerEvent
)

 Helper function registered to the underlying button when drag is detected CommonButtonBase.h  

virtual void HandleButtonDragEnter ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 Helper function registered to the underlying button when dragged widget enters CommonButtonBase.h  

virtual void HandleButtonDragLeave ( const FDragDropEvent& DragDropEvent
)

 Helper function registered to the underlying button when dragged widget leaves CommonButtonBase.h  

virtual FReply HandleButtonDragOver ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 Helper function registered to the underlying button when dragged over CommonButtonBase.h  

virtual FReply HandleButtonDrop ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 Helper function registered to the underlying button when dropped during a drag drop operation CommonButtonBase.h  

virtual void HandleButtonPressed()

 Helper function registered to the underlying button when pressed CommonButtonBase.h  

virtual void HandleButtonReleased()

 Helper function registered to the underlying button when released CommonButtonBase.h  

virtual void HandleFocusLost()

 Helper function registered to the underlying button losing focus CommonButtonBase.h  

virtual void HandleFocusReceived()

 Helper function registered to the underlying button receiving focus CommonButtonBase.h  
  CommonButtonBase.h  

virtual void HandleTriggeringActionCommited ( bool& bPassthrough
)

   CommonButtonBase.h  

virtual void HoldReset()

   CommonButtonBase.h  

bool IsPersistentBinding()

   CommonButtonBase.h  

virtual void NativeOnActionComplete()

   CommonButtonBase.h  

virtual void NativeOnActionProgress ( float HeldPercent
)

 Bound to the hold progress of the bound key from the input action CommonButtonBase.h  

virtual void NativeOnClicked()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Clicked")

virtual void NativeOnCurrentTextStyleChanged()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Meta=(BlueprintProtected="true")
  • Category="Common Button"

virtual void NativeOnDeselected ( bool bBroadcast
)

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Deselected")

virtual void NativeOnDisabled()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Disabled")

virtual void NativeOnDoubleClicked()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Double Clicked")

virtual void NativeOnEnabled()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Enabled")

virtual bool NativeOnHoldProgress ( float DeltaTime
)

 Bound to the hold progress not related to the bound key CommonButtonBase.h  

virtual bool NativeOnHoldProgressRollback ( float DeltaTime
)

 Bound to the hold progress rollback not related to the bound key CommonButtonBase.h  

virtual void NativeOnHovered()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Hovered")

virtual void NativeOnPressed()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Pressed")

virtual void NativeOnReleased()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Released")

virtual void NativeOnSelected ( bool bBroadcast
)

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Selected")

virtual void NativeOnUnhovered()

   CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category=CommonButton
  • Meta=(DisplayName="On Unhovered")

void OnActionComplete()

 Callback fired when hold events complete CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category="Common Button"

void OnActionProgress ( float HeldPercent
)

 Callback fired continously during hold interactions CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category="Common Button"

void OnCurrentTextStyleChanged()

 Allows derived classes to take action when the current text style has changed CommonButtonBase.h
  • BlueprintImplementableEvent
  • Meta=(BlueprintProtected="true")
  • Category="Common Button"

virtual void OnInputMethodChanged ( ECommonInputType CurrentInputType
)

 Called via delegate when the input method changes CommonButtonBase.h  

void OnTriggeredInputActionChanged ( const FDataTableRowHandle& NewTriggeredAction
)

 Callback fired when input action datatable row changes CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category="Common Button"

void OnTriggeringEnhancedInputActionChanged ( const UInputAction* InInputAction
)

 Callback fired when enhanced input action changes CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category="Common Button"

void OnTriggeringInputActionChanged ( const FDataTableRowHandle& NewTriggeredAction
)

 Callback fired when triggered input action datatable row changes CommonButtonBase.h
  • BlueprintImplementableEvent
  • Category="Common Button"

void RefreshDimensions()

   CommonButtonBase.h  

void SetClickedSlateSoundOverride ( const FSlateSound& InClickedSlateSoundOverride
)

   CommonButtonBase.h  

void SetHoveredSlateSoundOverride ( const FSlateSound& InHoveredSlateSoundOverride
)

   CommonButtonBase.h  

void SetLockedClickedSlateSoundOverride ( const FSlateSound& InLockedClickedSlateSoundOverride
)

   CommonButtonBase.h  

void SetLockedHoveredSlateSoundOverride ( const FSlateSound& InLockedHoveredSlateSoundOverride
)

   CommonButtonBase.h  

void SetLockedPressedSlateSoundOverride ( const FSlateSound& InLockedPressedSlateSoundOverride
)

   CommonButtonBase.h  

void SetPressedSlateSoundOverride ( const FSlateSound& InPressedSlateSoundOverride
)

 In some scenarios, USoundBase* setters are bypassed, so standard setters must also be provided for sound override properties. CommonButtonBase.h  

void SetSelectedClickedSlateSoundOverride ( const FSlateSound& InSelectedClickedSlateSoundOverride
)

   CommonButtonBase.h  

void SetSelectedHoveredSlateSoundOverride ( const FSlateSound& InSelectedHoveredSlateSoundOverride
)

   CommonButtonBase.h  

void SetSelectedInternal ( bool bInSelected,
bool bAllowSound,
bool bBroadcast
)

 Internal method to allow the selected state to be set regardless of selectability or toggleability CommonButtonBase.h
  • BlueprintCallable
  • Meta=(BlueprintProtected="true")
  • Category="Common Button"

void SetSelectedPressedSlateSoundOverride ( const FSlateSound& InSelectedPressedSlateSoundOverride
)

   CommonButtonBase.h  
This should be used as a check before calling NativeOnHovered and NativeOnUnhovered. CommonButtonBase.h  

void StopDoubleClickPropagation()

 Unless this is called, we will assume the double click should be converted into a normal click. CommonButtonBase.h
  • BlueprintCallable
  • Category=CommonButton

virtual void UnbindInputMethodChangedDelegate()

 Helper function to unbind from input method change events CommonButtonBase.h  

virtual void UnbindTriggeringInputActionToClick()

 Associates this button at its priority with the given key CommonButtonBase.h  

virtual void UpdateHoldData ( ECommonInputType CurrentInputType
)

 If HoldData is valid, assigns its values to Keyboard and Mouse, Gamepad and Touch, based off the Current Input Type. CommonButtonBase.h  

virtual void UpdateInputActionWidget()

 Helper function to update the associated input action widget, if any, based upon the state of the button CommonButtonBase.h  

void UpdateInputActionWidgetVisibility()

   CommonButtonBase.h  

Overridden from UUserWidget

Name Remarks Include Path Unreal Specifiers

virtual void NativeOnDragDetected ( const FGeometry& InGeometry,
const FPointerEvent& InMouseEvent,
UDragDropOperation*& OutOperation
)

   CommonButtonBase.h  

virtual void NativeOnDragEnter ( const FGeometry& InGeometry,
const FDragDropEvent& InDragDropEvent,
UDragDropOperation* InOperation
)

   CommonButtonBase.h  

virtual void NativeOnDragLeave ( const FDragDropEvent& InDragDropEvent,
UDragDropOperation* InOperation
)

   CommonButtonBase.h  

virtual bool NativeOnDragOver ( const FGeometry& InGeometry,
const FDragDropEvent& InDragDropEvent,
UDragDropOperation* InOperation
)

   CommonButtonBase.h  

virtual bool NativeOnDrop ( const FGeometry& InGeometry,
const FDragDropEvent& InDragDropEvent,
UDragDropOperation* InOperation
)

   CommonButtonBase.h  

virtual FReply NativeOnFocusReceived ( const FGeometry& InGeometry,
const FFocusEvent& InFocusEvent
)

   CommonButtonBase.h  

virtual void NativeOnMouseEnter ( const FGeometry& InGeometry,
const FPointerEvent& InMouseEvent
)

   CommonButtonBase.h  

virtual void NativeOnMouseLeave ( const FPointerEvent& InMouseEvent
)

   CommonButtonBase.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

   CommonButtonBase.h  

virtual void OnCreationFromPalette()

   CommonButtonBase.h  

virtual void OnWidgetRebuilt()

   CommonButtonBase.h  

virtual void SynchronizeProperties()

   CommonButtonBase.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   CommonButtonBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page