unreal.CommonButtonStyle

class unreal.CommonButtonStyle(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

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

C++ Source:

• Plugin: CommonUI

• Module: CommonUI

• File: CommonButtonBase.h

Editor Properties: (see get_editor_property/set_editor_property)

• button_padding (Margin): [Read-Write] The button content padding to apply for each size

• custom_padding (Margin): [Read-Write] The custom padding of the button to use for each size

• disabled (SlateBrush): [Read-Write] The disabled brush to apply to each size of this button

• disabled_text_style (type(Class)): [Read-Write] The text style to use when disabled

• hovered_slate_sound (SlateSound): [Read-Write] The sound to play when the button is hovered

• locked_hovered_slate_sound (CommonButtonStyleOptionalSlateSound): [Read-Write] The sound to play when the button is hovered while locked

• locked_pressed_slate_sound (CommonButtonStyleOptionalSlateSound): [Read-Write] The sound to play when the button is pressed while locked

• min_height (int32): [Read-Write] The minimum height of buttons using this style

• min_width (int32): [Read-Write] The minimum width of buttons using this style

• normal_base (SlateBrush): [Read-Write] The normal (un-selected) brush to apply to each size of this button

• normal_hovered (SlateBrush): [Read-Write] The normal (un-selected) brush to apply to each size of this button when hovered

• normal_hovered_text_style (type(Class)): [Read-Write] The text style to use when un-selected

• normal_pressed (SlateBrush): [Read-Write] The normal (un-selected) brush to apply to each size of this button when pressed

• normal_text_style (type(Class)): [Read-Write] The text style to use when un-selected

• pressed_slate_sound (SlateSound): [Read-Write] The sound to play when the button is pressed

• selected_base (SlateBrush): [Read-Write] The selected brush to apply to each size of this button

• selected_hovered (SlateBrush): [Read-Write] The selected brush to apply to each size of this button when hovered

• selected_hovered_slate_sound (CommonButtonStyleOptionalSlateSound): [Read-Write] The sound to play when the button is hovered while selected

• selected_hovered_text_style (type(Class)): [Read-Write] The text style to use when un-selected

• selected_pressed (SlateBrush): [Read-Write] The selected brush to apply to each size of this button when pressed

• selected_pressed_slate_sound (CommonButtonStyleOptionalSlateSound): [Read-Write] The sound to play when the button is pressed while selected

• selected_text_style (type(Class)): [Read-Write] The text style to use when selected

• single_material (bool): [Read-Write] Whether or not the style uses a drop shadow

• single_material_brush (SlateBrush): [Read-Write] The normal (un-selected) brush to apply to each size of this button

property button_padding: Margin

[Read-Only] The button content padding to apply for each size

Type:

(Margin)

property custom_padding: Margin

[Read-Only] The custom padding of the button to use for each size

Type:

(Margin)

property disabled: SlateBrush

[Read-Only] The disabled brush to apply to each size of this button

Type:

(SlateBrush)

property disabled_text_style: Class

[Read-Only] The text style to use when disabled

Type:

(type(Class))

get_button_padding() → Margin

Get Button Padding

Returns:

out_button_padding (Margin):

Return type:

Margin

get_custom_padding() → Margin

Get Custom Padding

Returns:

out_custom_padding (Margin):

Return type:

Margin

get_disabled_brush() → SlateBrush

Get Disabled Brush

Returns:

brush (SlateBrush):

Return type:

SlateBrush

get_disabled_text_style() → CommonTextStyle

Get Disabled Text Style

Return type:

CommonTextStyle

get_material_brush() → SlateBrush

Get Material Brush

Returns:

brush (SlateBrush):

Return type:

SlateBrush

get_normal_base_brush() → SlateBrush

Get Normal Base Brush

Returns:

brush (SlateBrush):

Return type:

SlateBrush

get_normal_hovered_brush() → SlateBrush

Get Normal Hovered Brush

Returns:

brush (SlateBrush):

Return type:

SlateBrush

get_normal_hovered_text_style() → CommonTextStyle

Get Normal Hovered Text Style

Return type:

CommonTextStyle

get_normal_pressed_brush() → SlateBrush

Get Normal Pressed Brush

Returns:

brush (SlateBrush):

Return type:

SlateBrush

get_normal_text_style() → CommonTextStyle

Get Normal Text Style

Return type:

CommonTextStyle

get_selected_base_brush() → SlateBrush

Get Selected Base Brush

Returns:

brush (SlateBrush):

Return type:

SlateBrush

get_selected_hovered_brush() → SlateBrush

Get Selected Hovered Brush

Returns:

brush (SlateBrush):

Return type:

SlateBrush

get_selected_hovered_text_style() → CommonTextStyle

Get Selected Hovered Text Style

Return type:

CommonTextStyle

get_selected_pressed_brush() → SlateBrush

Get Selected Pressed Brush

Returns:

brush (SlateBrush):

Return type:

SlateBrush

get_selected_text_style() → CommonTextStyle

Get Selected Text Style

Return type:

CommonTextStyle

property hovered_slate_sound: SlateSound

[Read-Only] The sound to play when the button is hovered

Type:

(SlateSound)

property locked_hovered_slate_sound: CommonButtonStyleOptionalSlateSound

[Read-Only] The sound to play when the button is hovered while locked

Type:

(CommonButtonStyleOptionalSlateSound)

property locked_pressed_slate_sound: CommonButtonStyleOptionalSlateSound

[Read-Only] The sound to play when the button is pressed while locked

Type:

(CommonButtonStyleOptionalSlateSound)

property min_height: int

[Read-Only] The minimum height of buttons using this style

Type:

(int32)

property min_width: int

[Read-Only] The minimum width of buttons using this style

Type:

(int32)

property normal_base: SlateBrush

[Read-Only] The normal (un-selected) brush to apply to each size of this button

Type:

(SlateBrush)

property normal_hovered: SlateBrush

[Read-Only] The normal (un-selected) brush to apply to each size of this button when hovered

Type:

(SlateBrush)

property normal_hovered_text_style: Class

[Read-Only] The text style to use when un-selected

Type:

(type(Class))

property normal_pressed: SlateBrush

[Read-Only] The normal (un-selected) brush to apply to each size of this button when pressed

Type:

(SlateBrush)

property normal_text_style: Class

[Read-Only] The text style to use when un-selected

Type:

(type(Class))

property pressed_slate_sound: SlateSound

[Read-Only] The sound to play when the button is pressed

Type:

(SlateSound)

property selected_base: SlateBrush

[Read-Only] The selected brush to apply to each size of this button

Type:

(SlateBrush)

property selected_hovered: SlateBrush

[Read-Only] The selected brush to apply to each size of this button when hovered

Type:

(SlateBrush)

property selected_hovered_slate_sound: CommonButtonStyleOptionalSlateSound

[Read-Only] The sound to play when the button is hovered while selected

Type:

(CommonButtonStyleOptionalSlateSound)

property selected_hovered_text_style: Class

[Read-Only] The text style to use when un-selected

Type:

(type(Class))

property selected_pressed: SlateBrush

[Read-Only] The selected brush to apply to each size of this button when pressed

Type:

(SlateBrush)

property selected_pressed_slate_sound: CommonButtonStyleOptionalSlateSound

[Read-Only] The sound to play when the button is pressed while selected

Type:

(CommonButtonStyleOptionalSlateSound)

property selected_text_style: Class

[Read-Only] The text style to use when selected

Type:

(type(Class))

property single_material: bool

[Read-Only] Whether or not the style uses a drop shadow

Type:

(bool)

property single_material_brush: SlateBrush

[Read-Only] The normal (un-selected) brush to apply to each size of this button

Type:

(SlateBrush)