1. Epic GamesDeveloper
  3. SCompoundWidget

SCompoundWidget

A CompoundWidget is the base from which most non-primitive widgets should be built.

API > API/Runtime > API/Runtime/SlateCore > API/Runtime/SlateCore/Widgets

Inheritance Hierarchy

References

   
Module SlateCore
Header /Engine/Source/Runtime/SlateCore/Public/Widgets/SCompoundWidget.h
Include #include "Widgets/SCompoundWidget.h"

Syntax

class SCompoundWidget : public SWidget

Remarks

A CompoundWidget is the base from which most non-primitive widgets should be built. CompoundWidgets have a protected member named ChildSlot.

Variables

  Type Name Description
Protected variable FCompoundWidgetOneChildSlot ChildSlot The slot that contains this widget's descendants.

Constructors

  Type Name Description
Protected function   Disallow public construction

Functions

  Type Name Description
Public function Const FLinearColor Gets the widget's color.
Protected function Const TSlateAttributeRef< FLinearColor >  
Public function Const const FVector2D Returns the size scaling factor for this widget.
Protected function Const TSlateAttributeRef< FVector2D >  
Protected function Const TSlateAttributeRef< FSlateColor >  
Public function void

SetColorAndOpacity ( TAttribute< FLinearColor > InColorAndOpacity
)

 Sets the widget's color.
Public function void

SetContentScale ( TAttribute< FVector2D > InContentScale
)

 Sets the content scale for this widget.
Public function void

SetForegroundColor ( TAttribute< FSlateColor > InForegroundColor
)

 Sets the widget's foreground color.
Public function Static const FSlateWidgetClassData &  

Overridden from SWidget

  Type Name Description
Protected function Virtual Const FVector2D

ComputeDesiredSize ( float LayoutScaleMultiplier
)

 Compute the ideal size necessary to display this widget.
Public function Virtual FChildren * Returns the useful children (if any) of this widget.
Public function Virtual Const FSlateColor  
Public function Virtual Const void

OnArrangeChildren ( const FGeometry& AllottedGeometry,
FArrangedChildren& ArrangedChildren
)

 Compute the Geometry of all the children and add populate the ArrangedChildren list with their values.
Public function Virtual Const int32

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

 The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.
Public function Virtual void

SetVisibility ( TAttribute< EVisibility > InVisibility
)

  

Overridden from FSlateControlledConstruction

  Type Name Description
Public function Virtual Const const FSlateWidgetClassData &  

Classes

  Type Name Description
Protected struct FCompoundWidgetOneChildSlot    

Typedefs

Name Description
PrivateParentType  
PrivateThisType  
Super  
ThisClass  

Deprecated Variables

  Type Name Description
Protected variable TSlateDeprecatedTAttribute< FLinearColor > ColorAndOpacity Direct access to ColorAndOpacity is now deprecated. Use the setter or getter.
Protected variable TSlateDeprecatedTAttribute< FVector2D > ContentScale Direct access to ContentScale is now deprecated. Use the setter or getter.
Protected variable TSlateDeprecatedTAttribute< FSlateColor > ForegroundColor Direct access to ForegroundColor is now deprecated. Use the setter or getter.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page