UWidgetStudioDivider Class Reference

A visual divider used to divide content. More...

#include <WSDivider.h>

Inheritance diagram for UWidgetStudioDivider:

Public Member Functions
TEnumAsByte< EOrientation >	GetOrientation () const
	Returns the orientation of the divider.
float	GetThickness () const
	Returns the thickness of the divider.
float	GetLength () const
	Returns the length of the divider.
float	GetOpacity () const
	Returns the opacity of the divider.
float	GetLeadingSpace () const
	Returns the space allocated above (Horizontal Orientation) or left (Vertical Orientation) of the divider.
float	GetTrailingSpace () const
	Returns the space allocated below (Horizontal Orientation) or right (Vertical Orientation) of the divider.
EPalette	GetColor () const
	Returns the color of the divider.
void	SetOrientation (TEnumAsByte< EOrientation > NewOrientation)
	Set the orientation of the divider. More...
void	SetThickness (float NewValue)
	Set the thickness of the divider. More...
void	SetLength (float NewValue)
	Set the length of the divider. More...
void	SetOpacity (float NewValue)
	Set the opacity of the divider. More...
void	SetLeadingSpace (float NewValue)
	Sets the space allocated above (Horizontal Orientation) or left (Vertical Orientation) of the divider. More...
void	SetTrailingSpace (float NewValue)
	Sets the space allocated below (Horizontal Orientation) or right (Vertical Orientation) of the divider. More...
void	SetColor (EPalette NewColor)
	Set the color of the divider. 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 *	SpaceAllocation = nullptr
USizeBox *	SizeBox = nullptr
UScaleBox *	ScaleBox = nullptr
UImage *	ImageItem = nullptr

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 visual divider used to divide content.

Member Function Documentation

InitializeStyling()

void UWidgetStudioDivider::InitializeStyling ( )

overrideprotectedvirtual

Reimplemented from UWidgetStudioBase.

SetColor()

void UWidgetStudioDivider::SetColor

(

EPalette

NewColor

)

Set the color of the divider.

Parameters

NewColor

The color to set the divider to.

SetLeadingSpace()

void UWidgetStudioDivider::SetLeadingSpace

(

float

NewValue

)

Sets the space allocated above (Horizontal Orientation) or left (Vertical Orientation) of the divider.

Parameters

NewValue

The value to set how much space/padding is before the divider.

SetLength()

void UWidgetStudioDivider::SetLength

(

float

NewValue

)

Set the length of the divider.

Parameters

NewValue

The value to set the length of the divider.

SetOpacity()

void UWidgetStudioDivider::SetOpacity

(

float

NewValue

)

Set the opacity of the divider.

Parameters

NewValue

The value to set the opacity of the divider.

SetOrientation()

void UWidgetStudioDivider::SetOrientation

(

TEnumAsByte< EOrientation >

NewOrientation

)

Set the orientation of the divider.

Parameters

NewOrientation

The orientation to set the divider to.

SetThickness()

void UWidgetStudioDivider::SetThickness

(

float

NewValue

)

Set the thickness of the divider.

Parameters

NewValue

The value to set the thickness of the divider.

SetTrailingSpace()

void UWidgetStudioDivider::SetTrailingSpace

(

float

NewValue

)

Sets the space allocated below (Horizontal Orientation) or right (Vertical Orientation) of the divider.

Parameters

NewValue

The value to set how much space/padding is after the divider.

UpdateStyling()

void UWidgetStudioDivider::UpdateStyling ( )

overrideprotectedvirtual

Reimplemented from UWidgetStudioBase.

---

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

• src/WidgetStudio/Source/WidgetStudioRuntime/Public/Widgets/Utility/WSDivider.h
• src/WidgetStudio/Source/WidgetStudioRuntime/Private/Widgets/Utility/WSDivider.cpp