Can't find any content

Error loading documents tree: Nothing found

  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

Inheritance Hierarchy

  • UObject
  • UCommonButtonStyle

References

   
Module CommonUI
Header /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonButtonBase.h
Include #include "CommonButtonBase.h"

Syntax

UCLASS (Abstract, Blueprintable, MinimalAPI, ClassGroup=UI, Meta=(Category="Common UI"))  
class UCommonButtonStyle : public UObject

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly bool bSingleMaterial Whether or not the style uses a drop shadow
Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly FMargin ButtonPadding The button content padding to apply for each size
Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly FMargin CustomPadding The custom padding of the button to use for each size
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly FSlateBrush Disabled The disabled brush to apply to each size of this button
Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly TSubclassOf< UCommonTextStyle > DisabledTextStyle The text style to use when disabled
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly FSlateSound HoveredSlateSound The sound to play when the button is hovered
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly FCommonButtonStyleOptionalSlateSound LockedHoveredSlateSound The sound to play when the button is hovered while locked
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly FCommonButtonStyleOptionalSlateSound LockedPressedSlateSound The sound to play when the button is pressed while locked
Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly int32 MinHeight The minimum height of buttons using this style
Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly int32 MinWidth The minimum width of buttons using this style
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly FSlateBrush NormalBase The normal (un-selected) brush to apply to each size of this button
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly FSlateBrush NormalHovered The normal (un-selected) brush to apply to each size of this button when hovered
Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly TSubclassOf< UCommonTextStyle > NormalHoveredTextStyle The text style to use when un-selected
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly FSlateBrush NormalPressed The normal (un-selected) brush to apply to each size of this button when pressed
Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly TSubclassOf< UCommonTextStyle > NormalTextStyle The text style to use when un-selected
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly FSlateSound PressedSlateSound The sound to play when the button is pressed
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly FSlateBrush SelectedBase The selected brush to apply to each size of this button
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly FSlateBrush SelectedHovered The selected brush to apply to each size of this button when hovered
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly FCommonButtonStyleOptionalSlateSound SelectedHoveredSlateSound The sound to play when the button is hovered while selected
Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly TSubclassOf< UCommonTextStyle > SelectedHoveredTextStyle The text style to use when un-selected
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly FSlateBrush SelectedPressed The selected brush to apply to each size of this button when pressed
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly FCommonButtonStyleOptionalSlateSound SelectedPressedSlateSound The sound to play when the button is pressed while selected
Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly TSubclassOf< UCommonTextStyle > SelectedTextStyle The text style to use when selected
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly FSlateBrush SingleMaterialBrush The normal (un-selected) brush to apply to each size of this button

Functions

  Type Name Description
Public function Const UFunction BlueprintCallable, Category void

GetButtonPadding ( FMargin& OutButtonPadding
)

  
Public function Const UFunction BlueprintCallable, Category void

GetCustomPadding ( FMargin& OutCustomPadding
)

  
Public function Const UFunction BlueprintCallable, Category void

GetDisabledBrush ( FSlateBrush& Brush
)

  
Public function Const UFunction BlueprintCallable, Category UCommonTextStyle *  
Public function Const UFunction BlueprintCallable, Category void

GetMaterialBrush ( FSlateBrush& Brush
)

  
Public function Const UFunction BlueprintCallable, Category void

GetNormalBaseBrush ( FSlateBrush& Brush
)

  
Public function Const UFunction BlueprintCallable, Category void

GetNormalHoveredBrush ( FSlateBrush& Brush
)

  
Public function Const UFunction BlueprintCallable, Category UCommonTextStyle *  
Public function Const UFunction BlueprintCallable, Category void

GetNormalPressedBrush ( FSlateBrush& Brush
)

  
Public function Const UFunction BlueprintCallable, Category UCommonTextStyle *  
Public function Const UFunction BlueprintCallable, Category void

GetSelectedBaseBrush ( FSlateBrush& Brush
)

  
Public function Const UFunction BlueprintCallable, Category void

GetSelectedHoveredBrush ( FSlateBrush& Brush
)

  
Public function Const UFunction BlueprintCallable, Category UCommonTextStyle *  
Public function Const UFunction BlueprintCallable, Category void

GetSelectedPressedBrush ( FSlateBrush& Brush
)

  
Public function Const UFunction BlueprintCallable, Category UCommonTextStyle *  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page