1. Epic GamesDeveloper
  3. UCommonButtonStyle

UCommonButtonStyle

- All properties must be EditDefaultsOnly, BlueprintReadOnly !!! -- we return the CDO to blueprints, so we cannot allow any changes (blueprint doesn't support const variables)

API > API/Plugins > API/Plugins/CommonUI

  • All properties must be EditDefaultsOnly, BlueprintReadOnly !!! -- we return the CDO to blueprints, so we cannot allow any changes (blueprint doesn't support const variables)
   
Name UCommonButtonStyle
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"))  
class UCommonButtonStyle : public UObject

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bSingleMaterial bool Whether or not the style uses a drop shadow CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
ButtonPadding FMargin The button content padding to apply for each size CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
ClickedSlateSound FSlateSound The sound to play when the button is clicked CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
  • Meta=(DisplayName="Clicked Sound")
CustomPadding FMargin The custom padding of the button to use for each size CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
Disabled FSlateBrush The disabled brush to apply to each size of this button CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Disabled"
  • Meta=(EditCondition="!bSingleMaterial")
DisabledTextStyle TSubclassOf< UCommonTextStyle > The text style to use when disabled CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
HoveredSlateSound FSlateSound The sound to play when the button is hovered CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
  • Meta=(DisplayName="Hovered Sound")
LockedClickedSlateSound FCommonButtonStyleOptionalSlateSound The sound to play when the button is clicked while locked CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
  • Meta=(DisplayName="Locked Clicked Sound")
LockedHoveredSlateSound FCommonButtonStyleOptionalSlateSound The sound to play when the button is hovered while locked CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
  • Meta=(DisplayName="Locked Hovered Sound")
LockedPressedSlateSound FCommonButtonStyleOptionalSlateSound The sound to play when the button is pressed while locked CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
  • Meta=(DisplayName="Locked Pressed Sound")
MaxHeight int32 The maximum height of buttons using this style CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
MaxWidth int32 The maximum width of buttons using this style CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
MinHeight int32 The minimum height of buttons using this style CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
MinWidth int32 The minimum width of buttons using this style CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
NormalBase FSlateBrush The normal (un-selected) brush to apply to each size of this button CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Normal"
  • Meta=(EditCondition="!bSingleMaterial")
NormalHovered FSlateBrush The normal (un-selected) brush to apply to each size of this button when hovered CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Normal"
  • Meta=(EditCondition="!bSingleMaterial")
NormalHoveredTextStyle TSubclassOf< UCommonTextStyle > The text style to use when un-selected CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
NormalPressed FSlateBrush The normal (un-selected) brush to apply to each size of this button when pressed CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Normal"
  • Meta=(EditCondition="!bSingleMaterial")
NormalTextStyle TSubclassOf< UCommonTextStyle > The text style to use when un-selected CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
PressedSlateSound FSlateSound The sound to play when the button is pressed CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
  • Meta=(DisplayName="Pressed Sound")
SelectedBase FSlateBrush The selected brush to apply to each size of this button CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Selected"
  • Meta=(EditCondition="!bSingleMaterial")
SelectedClickedSlateSound FCommonButtonStyleOptionalSlateSound The sound to play when the button is clicked while selected CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
  • Meta=(DisplayName="Selected Clicked Sound")
SelectedHovered FSlateBrush The selected brush to apply to each size of this button when hovered CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Selected"
  • Meta=(EditCondition="!bSingleMaterial")
SelectedHoveredSlateSound FCommonButtonStyleOptionalSlateSound The sound to play when the button is hovered while selected CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
  • Meta=(DisplayName="Selected Hovered Sound")
SelectedHoveredTextStyle TSubclassOf< UCommonTextStyle > The text style to use when un-selected CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
SelectedPressed FSlateBrush The selected brush to apply to each size of this button when pressed CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Selected"
  • Meta=(EditCondition="!bSingleMaterial")
SelectedPressedSlateSound FCommonButtonStyleOptionalSlateSound The sound to play when the button is pressed while selected CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
  • Meta=(DisplayName="Selected Pressed Sound")
SelectedTextStyle TSubclassOf< UCommonTextStyle > The text style to use when selected CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
SingleMaterialBrush FSlateBrush The normal (un-selected) brush to apply to each size of this button CommonButtonBase.h
  • EditDefaultsOnly
  • BlueprintReadOnly
  • Category="Properties"
  • Meta=(EditCondition="bSingleMaterial")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void GetButtonPadding ( FMargin& OutButtonPadding
) const

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

void GetCustomPadding ( FMargin& OutCustomPadding
) const

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

void GetDisabledBrush ( FSlateBrush& Brush
) const

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

UCommonTextStyle * GetDisabledTextStyle()

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

void GetMaterialBrush ( FSlateBrush& Brush
) const

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

void GetNormalBaseBrush ( FSlateBrush& Brush
) const

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

void GetNormalHoveredBrush ( FSlateBrush& Brush
) const

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

UCommonTextStyle * GetNormalHoveredTextStyle()

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

void GetNormalPressedBrush ( FSlateBrush& Brush
) const

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

UCommonTextStyle * GetNormalTextStyle()

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

void GetSelectedBaseBrush ( FSlateBrush& Brush
) const

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

void GetSelectedHoveredBrush ( FSlateBrush& Brush
) const

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

UCommonTextStyle * GetSelectedHoveredTextStyle()

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

void GetSelectedPressedBrush ( FSlateBrush& Brush
) const

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

UCommonTextStyle * GetSelectedTextStyle()

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page