1. Epic GamesDeveloper
  3. UCheckBox

UCheckBox

The checkbox widget allows you to display a toggled state of 'unchecked', 'checked' and 'indeterminable.

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Components

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Components/CheckBox.h
Include #include "Components/CheckBox.h"

Syntax

UCLASS (MinimalAPI)  
class UCheckBox : public UContentWidget

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintgetter, blueprintsetter, fieldnotify, getter, setter ECheckBoxState CheckedState Whether the check box is currently in a checked state
Public variable UProperty FGetCheckBoxState CheckedStateDelegate A bindable delegate for the IsChecked.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite blueprintsetter, getter, setter TEnumAsByte< EButtonClickMethod::Type > ClickMethod The type of mouse action required by the user to trigger the buttons 'Click'
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TEnumAsByte< EHorizontalAlignment > HorizontalAlignment How the content of the toggle button should align within the given space
Public variable UProperty Category, EditAnywhere BlueprintReadOnly getter bool IsFocusable Sometimes a button should only be mouse-clickable and never keyboard focusable.
Protected variable PRAGMA_DISABLE_DEPRECATION_WARNINGS ECheckBoxState K2_Cache_CheckedState  
Protected variable TSharedPtr< SCheckBox > MyCheckbox  
Public variable UProperty Category BlueprintAssignable FOnCheckBoxComponentStateChanged OnCheckStateChanged Called when the checked state has changed
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite blueprintsetter, getter, setter TEnumAsByte< EButtonPressMethod::Type > PressMethod The type of keyboard/gamepad button press action required by the user to trigger the buttons 'Click'
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite blueprintsetter, getter, setter TEnumAsByte< EButtonTouchMethod::Type > TouchMethod The type of touch action required by the user to trigger the buttons 'Click'
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FCheckBoxStyle WidgetStyle The checkbox bar style

Constructors

  Type Name Description
Public function  

UCheckBox ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const UFunction BlueprintCallable, Category ECheckBoxState Returns the full current checked state.
Public function Const EButtonClickMethod::Type Returns the click method.
Public function Const bool Is the checkbox focusable.
Public function Const EButtonPressMethod::Type Returns the press method.
Public function Const EButtonTouchMethod::Type Returns the touch method.
Public function Const const FCheckBoxStyle & Returns the local style.
Protected function void

InitCheckedStateDelegate ( FGetCheckBoxState InCheckedStateDelegate
)

  
Protected function void

InitIsFocusable ( bool InIsFocusable
)

 Initialize IsFocusable in the constructor before the SWidget is constructed.
Public function Const UFunction BlueprintCallable, Category bool Returns true if the checkbox is currently checked
Public function Const UFunction BlueprintCallable, Category bool Returns true if this button is currently pressed
Protected function ECheckBoxState  
Public function UFunction BlueprintCallable, Category void

SetCheckedState ( ECheckBoxState InCheckedState
)

 Sets the checked state.
Public function UFunction BlueprintCallable, Category void

SetClickMethod ( EButtonClickMethod::Type InClickMethod
)

 Sets the click method.
Public function UFunction BlueprintCallable, Category void

SetIsChecked ( bool InIsChecked
)

 Sets the checked state.
Public function UFunction BlueprintCallable, Category void

SetPressMethod ( EButtonPressMethod::Type InPressMethod
)

 Sets the press method.
Public function UFunction BlueprintCallable, Category void

SetTouchMethod ( EButtonTouchMethod::Type InTouchMethod
)

 Sets the touch method.
Public function void

SetWidgetStyle ( const FCheckBoxStyle& InStyle
)

 Sets the style.
Protected function void

SlateOnCheckStateChangedCallback ( ECheckBoxState NewState
)

  

Overridden from UPanelWidget

  Type Name Description
Protected function Virtual void UPanelWidget.
Protected function Virtual void  

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual TSharedRef< SWidget >

RebuildDesignWidget ( TSharedRef< SWidget > Content
)

  
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page