1. Epic GamesDeveloper
  3. SObjectWidget

SObjectWidget

The [SObjectWidget](API\Runtime\UMG\SObjectWidget) allows UMG to insert an [SWidget](API\Runtime\SlateCore\SWidget) into the hierarchy that manages the lifetime of the UMG [UWidget](API\Runtime\UMG\UWidget) that created it.

API > API/Runtime > API/Runtime/UMG

The SObjectWidget allows UMG to insert an SWidget into the hierarchy that manages the lifetime of the UMG UWidget that created it. Once the SObjectWidget is destroyed it frees the reference it holds to The UWidget allowing it to be garbage collected. It also forwards the slate events to the UUserWidget so that it can forward them to listeners.

   
Name SObjectWidget
Type class
Header File /Engine/Source/Runtime/UMG/Public/Slate/SObjectWidget.h
Include Path #include "Slate/SObjectWidget.h"

Syntax

class SObjectWidget :  
    public SCompoundWidget ,  
    public FGCObject

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

SObjectWidget()

   Slate/SObjectWidget.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~SObjectWidget()

   Slate/SObjectWidget.h  

Structs

Name Remarks
FArguments  

Typedefs

Name Type Remarks Include Path
PrivateParentType SCompoundWidget   Slate/SObjectWidget.h
PrivateThisType SObjectWidget   Slate/SObjectWidget.h
Super SCompoundWidget   Slate/SObjectWidget.h
ThisClass SObjectWidget   Slate/SObjectWidget.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
DebugName FString   Slate/SObjectWidget.h  
DebugPaintEventName FString   Slate/SObjectWidget.h  
DebugTickEventName FString   Slate/SObjectWidget.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Construct ( const FArguments& InArgs,
UUserWidget* InWidgetObject
)

   Slate/SObjectWidget.h  

UUserWidget * GetWidgetObject()

   Slate/SObjectWidget.h  

virtual void OnDragCancelled ( const FDragDropEvent& DragDropEvent,
UDragDropOperation* Operation
)

   Slate/SObjectWidget.h  

void ResetWidget()

   Slate/SObjectWidget.h  

void SetPadding ( const TAttribute< FMargin >& InMargin
)

   Slate/SObjectWidget.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual FVector2D ComputeDesiredSize ( float LayoutScaleMultiplier
) const

   Slate/SObjectWidget.h  

virtual bool IsInteractable()

   Slate/SObjectWidget.h  

virtual FReply OnAnalogValueChanged ( const FGeometry& MyGeometry,
const FAnalogInputEvent& InAnalogInputEvent
)

   Slate/SObjectWidget.h  

virtual FCursorReply OnCursorQuery ( const FGeometry& MyGeometry,
const FPointerEvent& CursorEvent
) const

   Slate/SObjectWidget.h  

virtual FReply OnDragDetected ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Slate/SObjectWidget.h  

virtual void OnDragEnter ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

   Slate/SObjectWidget.h  

virtual void OnDragLeave ( const FDragDropEvent& DragDropEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnDragOver ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnDrop ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

   Slate/SObjectWidget.h  

virtual void OnFinishedPointerInput()

   Slate/SObjectWidget.h  

virtual void OnFocusChanging ( const FWeakWidgetPath& PreviousFocusPath,
const FWidgetPath& NewWidgetPath,
const FFocusEvent& InFocusEvent
)

   Slate/SObjectWidget.h  

virtual void OnFocusLost ( const FFocusEvent& InFocusEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnFocusReceived ( const FGeometry& MyGeometry,
const FFocusEvent& InFocusEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnKeyChar ( const FGeometry& MyGeometry,
const FCharacterEvent& InCharacterEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnKeyUp ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnMotionDetected ( const FGeometry& MyGeometry,
const FMotionEvent& InMotionEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry,
const FPointerEvent& InMouseEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnMouseButtonUp ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Slate/SObjectWidget.h  

virtual void OnMouseCaptureLost ( const FCaptureLostEvent& CaptureLostEvent
)

   Slate/SObjectWidget.h  

virtual void OnMouseEnter ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Slate/SObjectWidget.h  

virtual void OnMouseLeave ( const FPointerEvent& MouseEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnMouseMove ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnMouseWheel ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Slate/SObjectWidget.h  

virtual FNavigationReply OnNavigation ( const FGeometry& MyGeometry,
const FNavigationEvent& InNavigationEvent
)

   Slate/SObjectWidget.h  

virtual int32 OnPaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
) const

   Slate/SObjectWidget.h  

virtual FReply OnPreviewKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnPreviewMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnTouchEnded ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnTouchFirstMove ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnTouchForceChanged ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnTouchGesture ( const FGeometry& MyGeometry,
const FPointerEvent& GestureEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnTouchMoved ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

   Slate/SObjectWidget.h  

virtual FReply OnTouchStarted ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

   Slate/SObjectWidget.h  

virtual bool SupportsKeyboardFocus()

   Slate/SObjectWidget.h  

virtual void Tick ( const FGeometry& AllottedGeometry,
const double InCurrentTime,
const float InDeltaTime
)

 SWidget Tick override. Slate/SObjectWidget.h  

Overridden from FSlateControlledConstruction

Name Remarks Include Path Unreal Specifiers

virtual const FSlateWidgetClassData & GetWidgetClass()

   Slate/SObjectWidget.h  

Overridden from FGCObject

Name Remarks Include Path Unreal Specifiers

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

   Slate/SObjectWidget.h  

virtual FString GetReferencerName()

   Slate/SObjectWidget.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FSlateWidgetClassData & GetPrivateWidgetClass()

   Slate/SObjectWidget.h  

static void PrivateRegisterAttributes ( FSlateAttributeInitializer&
)

   Slate/SObjectWidget.h  

static const FSlateWidgetClassData & StaticWidgetClass()

   Slate/SObjectWidget.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page