unreal.CheckBox

class unreal.CheckBox(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: ContentWidget

The checkbox widget allows you to display a toggled state of ‘unchecked’, ‘checked’ and ‘indeterminable. You can use the checkbox for a classic checkbox, or as a toggle button, or as radio buttons.

  • Single Child

  • Toggle

C++ Source:

  • Module: UMG

  • File: CheckBox.h

Editor Properties: (see get_editor_property/set_editor_property)

  • accessible_behavior (SlateAccessibleBehavior): [Read-Write] Accessible Behavior: Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.

  • accessible_summary_behavior (SlateAccessibleBehavior): [Read-Write] Accessible Summary Behavior: How to describe this widget when it’s being presented through a summary of a parent widget. If set to custom, additional customization options will appear.

  • accessible_summary_text (Text): [Read-Write] Accessible Summary Text: When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.

  • accessible_text (Text): [Read-Write] Accessible Text: When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.

  • can_children_be_accessible (bool): [Read-Write] Can Children be Accessible: Whether or not children of this widget can appear as distinct accessible widgets.

  • checked_state (CheckBoxState): [Read-Write] Checked State

  • click_method (ButtonClickMethod): [Read-Write] Click Method

  • clipping (WidgetClipping): [Read-Write] Clipping

  • cursor (MouseCursor): [Read-Write] Cursor

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Flow Direction Preference

  • horizontal_alignment (HorizontalAlignment): [Read-Write] Horizontal Alignment: How the content of the toggle button should align within the given space

  • is_enabled (bool): [Read-Write] Is Enabled

  • is_focusable (bool): [Read-Write] Is Focusable: Sometimes a button should only be mouse-clickable and never keyboard focusable.

  • is_volatile (bool): [Read-Write] Is Volatile: If true prevents the widget or its child’s geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.

  • navigation (WidgetNavigation): [Read-Write] Navigation: The navigation object for this widget is optionally created if the user has configured custom navigation rules for this widget in the widget designer. Those rules determine how navigation transitions can occur between widgets.

  • on_check_state_changed (OnCheckBoxComponentStateChanged): [Read-Write] On Check State Changed: Called when the checked state has changed

  • override_accessible_defaults (bool): [Read-Write] Override Accessible Defaults: Override all of the default accessibility behavior and text for this widget.

  • override_cursor (bool): [Read-Write] Override Cursor

  • press_method (ButtonPressMethod): [Read-Write] Press Method

  • render_opacity (float): [Read-Write] Render Opacity

  • render_transform (WidgetTransform): [Read-Write] Render Transform

  • render_transform_pivot (Vector2D): [Read-Write] Render Transform Pivot

  • slot (PanelSlot): [Read-Write] Slot: The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.

  • tool_tip_text (Text): [Read-Write] Tool Tip Text

  • tool_tip_widget (Widget): [Read-Only] Tool Tip Widget

  • touch_method (ButtonTouchMethod): [Read-Write] Touch Method

  • visibility (SlateVisibility): [Read-Write] Visibility

  • widget_style (CheckBoxStyle): [Read-Write] Widget Style

property checked_state: CheckBoxState

[Read-Write] Checked State

Type:

(CheckBoxState)

property click_method: ButtonClickMethod

[Read-Write] Click Method

Type:

(ButtonClickMethod)

get_checked_state() → CheckBoxState

Returns the full current checked state.

Return type:

CheckBoxState

property horizontal_alignment: HorizontalAlignment

[Read-Only] Horizontal Alignment: How the content of the toggle button should align within the given space

Type:

(HorizontalAlignment)

is_checked() → bool

Returns true if the checkbox is currently checked

Return type:

bool

property is_focusable: bool

[Read-Only] Is Focusable: Sometimes a button should only be mouse-clickable and never keyboard focusable.

Type:

(bool)

is_pressed() → bool

Returns true if this button is currently pressed

Return type:

bool

property on_check_state_changed: OnCheckBoxComponentStateChanged

[Read-Write] On Check State Changed: Called when the checked state has changed

Type:

(OnCheckBoxComponentStateChanged)

property press_method: ButtonPressMethod

[Read-Write] Press Method

Type:

(ButtonPressMethod)

set_checked_state(checked_state) → None

Sets the checked state.

Parameters:

checked_state (CheckBoxState) –

set_click_method(click_method) → None

Sets the click method.

Parameters:

click_method (ButtonClickMethod) –

set_is_checked(is_checked) → None

Sets the checked state.

Parameters:

is_checked (bool) –

set_press_method(press_method) → None

Sets the press method.

Parameters:

press_method (ButtonPressMethod) –

set_touch_method(touch_method) → None

Sets the touch method.

Parameters:

touch_method (ButtonTouchMethod) –

property touch_method: ButtonTouchMethod

[Read-Write] Touch Method

Type:

(ButtonTouchMethod)

property widget_style: CheckBoxStyle

[Read-Write] Widget Style

Type:

(CheckBoxStyle)