unreal.CommonButtonStyle

class unreal.CommonButtonStyle(outer=None, name='None')

Bases: unreal.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] Button Padding: The button content padding to apply for each size

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

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

  • disabled_hovered_slate_sound (CommonButtonStyleOptionalSlateSound): [Read-Write] Disabled Hovered Slate Sound: The sound to play when the button is hovered while disabled

  • disabled_pressed_slate_sound (CommonButtonStyleOptionalSlateSound): [Read-Write] Disabled Pressed Slate Sound: The sound to play when the button is pressed while disabled

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

property button_padding

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

Type

(Margin)

property custom_padding

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

Type

(Margin)

property disabled

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

Type

(SlateBrush)

property disabled_hovered_slate_sound

[Read-Only] Disabled Hovered Slate Sound: The sound to play when the button is hovered while disabled

Type

(CommonButtonStyleOptionalSlateSound)

property disabled_pressed_slate_sound

[Read-Only] Disabled Pressed Slate Sound: The sound to play when the button is pressed while disabled

Type

(CommonButtonStyleOptionalSlateSound)

property disabled_text_style

[Read-Only] Disabled Text Style: 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

[Read-Only] Hovered Slate Sound: The sound to play when the button is hovered

Type

(SlateSound)

property min_height

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

Type

(int32)

property min_width

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

Type

(int32)

property normal_base

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

Type

(SlateBrush)

property normal_hovered

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

Type

(SlateBrush)

property normal_hovered_text_style

[Read-Only] Normal Hovered Text Style: The text style to use when un-selected

Type

(type(Class))

property normal_pressed

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

Type

(SlateBrush)

property normal_text_style

[Read-Only] Normal Text Style: The text style to use when un-selected

Type

(type(Class))

property pressed_slate_sound

[Read-Only] Pressed Slate Sound: The sound to play when the button is pressed

Type

(SlateSound)

property selected_base

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

Type

(SlateBrush)

property selected_hovered

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

Type

(SlateBrush)

property selected_hovered_slate_sound

[Read-Only] Selected Hovered Slate Sound: The sound to play when the button is hovered while selected

Type

(CommonButtonStyleOptionalSlateSound)

property selected_hovered_text_style

[Read-Only] Selected Hovered Text Style: The text style to use when un-selected

Type

(type(Class))

property selected_pressed

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

Type

(SlateBrush)

property selected_pressed_slate_sound

[Read-Only] Selected Pressed Slate Sound: The sound to play when the button is pressed while selected

Type

(CommonButtonStyleOptionalSlateSound)

property selected_text_style

[Read-Only] Selected Text Style: The text style to use when selected

Type

(type(Class))

property single_material

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

Type

(bool)

property single_material_brush

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

Type

(SlateBrush)