Widget Studio
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
UWidgetStudioLabel Class Reference

A widget that displays a text label and accepts a single widget as a child. More...

#include <WSLabel.h>

Inheritance diagram for UWidgetStudioLabel:
UWidgetStudioBase

Public Member Functions

FText GetLabelText () const
 Returns the labels text.
 
FWSTextStyle GetLabelOptions () const
 Returns the text options for the label.
 
EWSPlacement GetLabelPlacement () const
 Returns the placement of the label in relevance to the slotted widget.
 
float GetLabelPadding () const
 Returns the padding between the label and the slotted widget.
 
UWidget * GetSlottedWidget () const
 Returns the slotted widget.
 
void SetLabelText (FText NewText)
 Set the text displayed on the label.
 
void SetLabelOptions (FWSTextStyle NewLabelOptions)
 Set the text options for the label. More...
 
void SetLabelPlacement (EWSPlacement NewPlacement)
 Set the placement of the label in relevance to the slotted widget. More...
 
void SetLabelPadding (float NewPadding)
 Set the padding between the label and the slotted widget. More...
 
- Public Member Functions inherited from UWidgetStudioBase
FVector2D GetDimensions () const
 Returns the current X and Y dimensions of the Widget. More...
 
int32 GetBorderRadius () const
 Returns the current border radius of the Widget. More...
 
void ForceStyleUpdate ()
 Refresh the dynamic styling of the Widget Studio widget.
 
void SetSizeModifier (ESizeModifier InSizeModifier)
 Set the size modifier of the Widget Studio widget.
 

Protected Member Functions

virtual TSharedRef< SWidget > RebuildWidget () override
 
virtual int32 NativePaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override
 
virtual void SynchronizeProperties () override
 
virtual void InitializeStyling () override
 
virtual void UpdateStyling () override
 
- Protected Member Functions inherited from UWidgetStudioBase
virtual void NativeOnMouseEnter (const FGeometry &InGeometry, const FPointerEvent &InMouseEvent) override
 
virtual void NativeOnMouseLeave (const FPointerEvent &InMouseEvent) override
 
virtual void NativeOnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent) override
 

Protected Attributes

UOverlay * Retainer = nullptr
 
UHorizontalBox * HBox = nullptr
 
UVerticalBox * VBox = nullptr
 
UWidgetStudioText * TextItem = nullptr
 
UNamedSlot * WidgetSlot = nullptr
 
FText LabelText = FText().FromString("Label")
 The text to display on the label.
 
FWSTextStyle TextStyle = FWSTextStyle{}
 Setup how the text is styled.
 
EWSPlacement LabelPlacement = EWSPlacement::Left
 Where to place the label in relevance to the child widget.
 
float LabelPadding = 30.0f
 The spacing/padding between the label and the widget. More...
 

Additional Inherited Members

- Public Attributes inherited from UWidgetStudioBase
FWSBaseHoverStateDelegate OnHoverStateChanged
 Called when the hover state has been changed.
 
bool bCanOverrideDimensions = true
 Used to enable or disable dimension override's.
 
bool bCanOverrideBorderRadius = true
 Used to enable or disable dimension override's.
 
FVector2D MinimumDimensions = FVector2D(50, 7)
 The minimum dimensions of the widget. More...
 
bool bDisablePainting = false
 Used for debugging. More...
 
float AnimationTime = 7
 The animation interpolation speed. More...
 
ESizeModifier SizeModifier = ESizeModifier::Regular
 Quickly modify the overall size of the widget. More...
 
FVector2D OverrideDimensions = FVector2D(0, 0)
 Manually adjust the X and Y dimensions of the widget. More...
 
int32 OverrideBorderRadius = -1
 Manually adjust the border radius of the widget. More...
 

Detailed Description

A widget that displays a text label and accepts a single widget as a child.

Member Function Documentation

◆ InitializeStyling()

void UWidgetStudioLabel::InitializeStyling ( )
overrideprotectedvirtual

Reimplemented from UWidgetStudioBase.

◆ SetLabelOptions()

void UWidgetStudioLabel::SetLabelOptions ( FWSTextStyle  NewLabelOptions)

Set the text options for the label.

Parameters
NewLabelOptionsThe text options for the label.

◆ SetLabelPadding()

void UWidgetStudioLabel::SetLabelPadding ( float  NewPadding)

Set the padding between the label and the slotted widget.

Parameters
NewPaddingThe padding between the label and the slotted widget.

◆ SetLabelPlacement()

void UWidgetStudioLabel::SetLabelPlacement ( EWSPlacement  NewPlacement)

Set the placement of the label in relevance to the slotted widget.

Parameters
NewPlacementThe placement of the label in relevance to the slotted widget.

◆ UpdateStyling()

void UWidgetStudioLabel::UpdateStyling ( )
overrideprotectedvirtual

Reimplemented from UWidgetStudioBase.

Member Data Documentation

◆ LabelPadding

float UWidgetStudioLabel::LabelPadding = 30.0f
protected

The spacing/padding between the label and the widget.


The documentation for this class was generated from the following files: