unreal.CommonButtonGroupBase

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

Bases: unreal.CommonWidgetGroupBase

Manages an arbitrary collection of CommonButton widgets. Ensures that no more (and optionally, no less) than one button in the group is selected at a time

C++ Source:

  • Plugin: CommonUI

  • Module: CommonUI

  • File: CommonButtonGroupBase.h

Editor Properties: (see get_editor_property/set_editor_property)

  • on_button_base_clicked (SimpleButtonBaseGroupDelegate): [Read-Write] On Button Base Clicked

  • on_button_base_double_clicked (SimpleButtonBaseGroupDelegate): [Read-Write] On Button Base Double Clicked

  • on_hovered_button_base_changed (SimpleButtonBaseGroupDelegate): [Read-Write] On Hovered Button Base Changed

  • on_selected_button_base_changed (SimpleButtonBaseGroupDelegate): [Read-Write] On Selected Button Base Changed

  • on_selection_cleared (OnSelectionCleared): [Read-Write] On Selection Cleared

  • selection_required (bool): [Read-Write] Selection Required: If true, the group will force that a button be selected at all times

deselect_all() None

Deselects all buttons in the group.

find_button_index(button_to_find) int32

Find the button index of the specified button, if possible

Parameters

button_to_find (CommonButtonBase) – Button to find the index of

Returns

Index of the button in the group. INDEX_NONE if not found

Return type

int32

get_button_base_at_index(index) CommonButtonBase

Get Button Base at Index

Parameters

index (int32) –

Return type

CommonButtonBase

get_button_count() int32

Get Button Count

Return type

int32

get_hovered_button_index() int32

Get the index of the currently hovered button, if any.

Return type

int32

get_selected_button_base() CommonButtonBase

Get Selected Button Base

Return type

CommonButtonBase

get_selected_button_index() int32

Get the index of the currently selected button, if any.

Return type

int32

has_any_buttons() bool

Has Any Buttons

Return type

bool

property on_button_base_clicked

[Read-Write] On Button Base Clicked

Type

(SimpleButtonBaseGroupDelegate)

property on_button_base_double_clicked

[Read-Write] On Button Base Double Clicked

Type

(SimpleButtonBaseGroupDelegate)

property on_hovered_button_base_changed

[Read-Write] On Hovered Button Base Changed

Type

(SimpleButtonBaseGroupDelegate)

property on_selected_button_base_changed

[Read-Write] On Selected Button Base Changed

Type

(SimpleButtonBaseGroupDelegate)

property on_selection_cleared

[Read-Write] On Selection Cleared

Type

(OnSelectionCleared)

select_button_at_index(button_index) None

Selects a button at a specific index in the group. Clears all selection if given an invalid index.

Parameters

button_index (int32) – The index of the button in the group to select

select_next_button(allow_wrap=True) None

Selects the next button in the group

Parameters

allow_wrap (bool) – Whether to wrap to the first button if the last one is currently selected

select_previous_button(allow_wrap=True) None

Selects the previous button in the group

Parameters

allow_wrap (bool) – Whether to wrap to the first button if the last one is currently selected

property selection_required

[Read-Only] Selection Required: If true, the group will force that a button be selected at all times

Type

(bool)

set_selection_required(require_selection) None

Sets whether the group should always have a button selected.

Parameters

require_selection (bool) – True to force the group to always have a button selected. If true and nothing is selected, will select the first entry. If empty, will select the first button added.