A modern styled text field. More...

#include <WSModernTextField.h>

Inheritance diagram for UWidgetStudioModernTextField:

Public Member Functions
bool	IsMultiLineSupportEnabled () const
	Returns if multi-line support is enabled or not.

ETextFieldIconVisibility	GetIconVisibility () const
	Returns the current icon visibility setting.

EIconItem	GetLeadingIcon () const
	Returns the leading icon.

EIconItem	GetTrailingIcon () const
	Returns the trailing icon.

EPalette	GetBackgroundColor () const
	Returns the background color.

EPalette	GetContentColor () const
	Returns the background color.

float	GetIconSize () const
	Returns the icon size.

void	SetMultiLineSupportEnabled (bool bNewState)
	Enable or disable the multi-line support. More...

void	SetIconVisibility (ETextFieldIconVisibility NewState)
	Sets the icon visibility. More...

void	SetLeadingIcon (EIconItem NewIcon)
	Sets the leading icon. More...

void	SetTrailingIcon (EIconItem NewIcon)
	Sets the trailing icon. More...

void	SetBackgroundColor (EPalette NewColor)
	Set the background color. More...

void	SetContentColor (EPalette NewColor)
	Set the content color. More...

void	SetIconSize (float NewSize)
	Set the icon size. More...

Public Member Functions inherited from UWidgetStudioTextFieldBase
FText	GetLabel () const
	Returns the label.

FText	GetText () const
	Returns the text in the text field.

FText	GetPlaceholderText () const
	Returns the placeholder text.

ETextFilter	GetFilter () const
	Returns the current set text filter.

int32	GetCharacterLimit () const
	Returns the character limit.

ETextFieldState	GetState () const
	Returns the current Text Field State.

bool	IsPasswordField () const
	Returns true if the text field is set to be a password field.

virtual void	SetLabel (FText NewLabel)
	Sets the label that appears above the text field. More...

virtual void	SetText (FText NewText)
	Sets the text in the Text Field. More...

virtual void	SetPlaceholderText (FText NewText)
	Sets the placeholder text in the Text Field. More...

virtual void	SetFilter (ETextFilter NewFilter)
	Sets and applies a new filter for the text in the text field. More...

virtual void	SetCharacterLimit (int32 NewLimit)
	Sets and applies the character limit. More...

virtual void	SetState (ETextFieldState NewState)
	Manually set the state of the Text Field. 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

EPalette	GetColorByState () const

Protected Member Functions inherited from UWidgetStudioTextFieldBase
	UWidgetStudioTextFieldBase (const FObjectInitializer &ObjectInitializer)

virtual void	OnTextInputTextChanged (const FText &InText)
	Called when the text within the field has changed. More...

virtual void	OnTextInputTextCommitted (const FText &InText, ETextCommit::Type InCommitMethod)
	Called when the text field has been committed. More...

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
FSlateBrush	ScrollBarBrush

UInvalidationBox *	Retainer = nullptr

UVerticalBox *	VBox = nullptr

UTextBlock *	LabelItem = nullptr

USizeBox *	SizeBox = nullptr

UOverlay *	Overlay = nullptr

UScaleBox *	BackgroundScaleBox = nullptr

UOverlay *	BackgroundOverlay = nullptr

UImage *	DropShadow = nullptr

UImage *	Background = nullptr

UImage *	BackgroundOutline = nullptr

UHorizontalBox *	HBox = nullptr

UScaleBox *	LeadingIconScaleBox = nullptr

UImage *	LeadingIconItem = nullptr

UScaleBox *	TrailingIconScaleBox = nullptr

UImage *	TrailingIconItem = nullptr

UWSEditableText *	TextInput = nullptr

UCustomMultiLineTextBox *	TextInputMultiLine = nullptr

Protected Attributes inherited from UWidgetStudioTextFieldBase
bool	bMultiLine = false
	Enable/disable multi-line support. More...

FText	Label
	The label of the text field. More...

FText	PlaceholderText = FText().FromString("Enter text here!")
	The text displayed in the Text Field when no text has been inputted.

FText	Text = FText().FromString("")
	The text displayed in the Text Field.

FWSTextStyle	TextStyle
	The text styling to apply to the text within the text field. More...

ETextFieldState	State = ETextFieldState::Normal
	The current state of the text field.

ETextFilter	Filter = ETextFilter::None
	How the text should be filtered.

int32	CharacterLimit = 0
	The limit on how many characters should allowed. More...

bool	bIsPasswordField = false
	Set the Text Field to password mode.

Additional Inherited Members
Public Attributes inherited from UWidgetStudioTextFieldBase
FWSTextFieldTextChangedDelegate	OnTextChanged

FWSTextFieldTextCommittedDelegate	OnTextCommitted

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 modern styled text field.

Member Function Documentation

◆ InitializeStyling()

void UWidgetStudioModernTextField::InitializeStyling ( )

overrideprotectedvirtual

Reimplemented from UWidgetStudioBase.

◆ SetBackgroundColor()

void UWidgetStudioModernTextField::SetBackgroundColor ( EPalette NewColor )

Set the background color.

Parameters

NewColor The new color to apply to the background of the widget.

◆ SetContentColor()

void UWidgetStudioModernTextField::SetContentColor ( EPalette NewColor )

Set the content color.

Parameters

NewColor The new color to apply to the content of the widget.

◆ SetIconSize()

void UWidgetStudioModernTextField::SetIconSize ( float NewSize )

Set the icon size.

Parameters

NewSize The new size to apply to the icon.

◆ SetIconVisibility()

void UWidgetStudioModernTextField::SetIconVisibility ( ETextFieldIconVisibility NewState )

Sets the icon visibility.

Parameters

NewState The new visibility state of the icon.

◆ SetLeadingIcon()

void UWidgetStudioModernTextField::SetLeadingIcon ( EIconItem NewIcon )

Sets the leading icon.

Parameters

NewIcon The new icon to display to the left of the Text Field.

◆ SetMultiLineSupportEnabled()

void UWidgetStudioModernTextField::SetMultiLineSupportEnabled ( bool bNewState )

Enable or disable the multi-line support.

Parameters

bNewState The new visibility state of the icon.

◆ SetTrailingIcon()

void UWidgetStudioModernTextField::SetTrailingIcon ( EIconItem NewIcon )

Sets the trailing icon.

Parameters

NewIcon The new icon to display to the right of the Text Field.

◆ SynchronizeProperties()

void UWidgetStudioModernTextField::SynchronizeProperties ( )

overrideprotectedvirtual

Reimplemented from UWidgetStudioTextFieldBase.

◆ UpdateStyling()

void UWidgetStudioModernTextField::UpdateStyling ( )

overrideprotectedvirtual

Reimplemented from UWidgetStudioBase.

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

src/WidgetStudio/Source/WidgetStudioRuntime/Public/Widgets/Modern/WSModernTextField.h
src/WidgetStudio/Source/WidgetStudioRuntime/Private/Widgets/Modern/WSModernTextField.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ InitializeStyling()

◆ SetBackgroundColor()

◆ SetContentColor()

◆ SetIconSize()

◆ SetIconVisibility()

◆ SetLeadingIcon()

◆ SetMultiLineSupportEnabled()

◆ SetTrailingIcon()

◆ SynchronizeProperties()

◆ UpdateStyling()