Navigation
API > API/Plugins > API/Plugins/CommonUI
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UCommonButtonStyle
References
| Module | CommonUI |
| Header | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonButtonBase.h |
| Include | #include "CommonButtonBase.h" |
Syntax
UCLASS&40;Abstract, Blueprintable, ClassGroup&61;UI, Meta&61;&40;Category&61;"Common UI"&41;&41;
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 | |
|---|---|---|---|
| bool | bSingleMaterial | Whether or not the style uses a drop shadow | |
| FMargin | ButtonPadding | The button content padding to apply for each size | |
| FMargin | CustomPadding | The custom padding of the button to use for each size | |
| FSlateBrush | Disabled | The disabled brush to apply to each size of this button | |
| TSubclassOf< UCommonTextStyle > | DisabledTextStyle | The text style to use when disabled | |
| FSlateSound | HoveredSlateSound | The sound to play when the button is hovered | |
| FCommonButtonStyleOptionalSlateSound | LockedHoveredSlateSound | The sound to play when the button is hovered while locked | |
| FCommonButtonStyleOptionalSlateSound | LockedPressedSlateSound | The sound to play when the button is pressed while locked | |
| int32 | MinHeight | The minimum height of buttons using this style | |
| int32 | MinWidth | The minimum width of buttons using this style | |
| FSlateBrush | NormalBase | The normal (un-selected) brush to apply to each size of this button | |
| FSlateBrush | NormalHovered | The normal (un-selected) brush to apply to each size of this button when hovered | |
| TSubclassOf< UCommonTextStyle > | NormalHoveredTextStyle | The text style to use when un-selected | |
| FSlateBrush | NormalPressed | The normal (un-selected) brush to apply to each size of this button when pressed | |
| TSubclassOf< UCommonTextStyle > | NormalTextStyle | The text style to use when un-selected | |
| FSlateSound | PressedSlateSound | The sound to play when the button is pressed | |
| FSlateBrush | SelectedBase | The selected brush to apply to each size of this button | |
| FSlateBrush | SelectedHovered | The selected brush to apply to each size of this button when hovered | |
| FCommonButtonStyleOptionalSlateSound | SelectedHoveredSlateSound | The sound to play when the button is hovered while selected | |
| TSubclassOf< UCommonTextStyle > | SelectedHoveredTextStyle | The text style to use when un-selected | |
| FSlateBrush | SelectedPressed | The selected brush to apply to each size of this button when pressed | |
| FCommonButtonStyleOptionalSlateSound | SelectedPressedSlateSound | The sound to play when the button is pressed while selected | |
| TSubclassOf< UCommonTextStyle > | SelectedTextStyle | The text style to use when selected | |
| FSlateBrush | SingleMaterialBrush | The normal (un-selected) brush to apply to each size of this button |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | GetButtonPadding
(
FMargin& OutButtonPadding |
||
| void | GetCustomPadding
(
FMargin& OutCustomPadding |
||
| void | GetDisabledBrush
(
FSlateBrush& Brush |
||
| UCommonTextStyle * | |||
| void | GetMaterialBrush
(
FSlateBrush& Brush |
||
| void | GetNormalBaseBrush
(
FSlateBrush& Brush |
||
| void | GetNormalHoveredBrush
(
FSlateBrush& Brush |
||
| UCommonTextStyle * | |||
| void | GetNormalPressedBrush
(
FSlateBrush& Brush |
||
| UCommonTextStyle * | |||
| void | GetSelectedBaseBrush
(
FSlateBrush& Brush |
||
| void | GetSelectedHoveredBrush
(
FSlateBrush& Brush |
||
| UCommonTextStyle * | |||
| void | GetSelectedPressedBrush
(
FSlateBrush& Brush |
||
| UCommonTextStyle * |