UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FEditableTextBoxStyle Struct Reference

#include <SlateTypes.h>

+ Inheritance diagram for FEditableTextBoxStyle:

Public Member Functions

SLATECORE_API FEditableTextBoxStyle ()
 
SLATECORE_API FEditableTextBoxStyle (const FEditableTextBoxStyle &)
 
SLATECORE_API FEditableTextBoxStyleoperator= (const FEditableTextBoxStyle &)
 
virtual SLATECORE_API ~FEditableTextBoxStyle ()
 
virtual SLATECORE_API void GetResources (TArray< const FSlateBrush * > &OutBrushes) const override
 
virtual const FName GetTypeName () const override
 
FEditableTextBoxStyleSetBackgroundImageNormal (const FSlateBrush &InBackgroundImageNormal)
 
FEditableTextBoxStyleSetBackgroundImageHovered (const FSlateBrush &InBackgroundImageHovered)
 
FEditableTextBoxStyleSetBackgroundImageFocused (const FSlateBrush &InBackgroundImageFocused)
 
FEditableTextBoxStyleSetBackgroundImageReadOnly (const FSlateBrush &InBackgroundImageReadOnly)
 
FEditableTextBoxStyleSetPadding (const FMargin &InPadding)
 
FEditableTextBoxStyleSetFont (const FSlateFontInfo &InFont)
 
FEditableTextBoxStyleSetFont (const FName &InFontName, float InSize)
 
FEditableTextBoxStyleSetTextStyle (const FTextBlockStyle &InTextStyle)
 
FEditableTextBoxStyleSetForegroundColor (const FSlateColor &InForegroundColor)
 
FEditableTextBoxStyleSetBackgroundColor (const FSlateColor &InBackgroundColor)
 
FEditableTextBoxStyleSetReadOnlyForegroundColor (const FSlateColor &InReadOnlyForegroundColor)
 
FEditableTextBoxStyleSetFocusedForegroundColor (const FSlateColor &InFocusedForegroundColor)
 
FEditableTextBoxStyleSetHScrollBarPadding (const FMargin &InPadding)
 
FEditableTextBoxStyleSetVScrollBarPadding (const FMargin &InPadding)
 
FEditableTextBoxStyleSetScrollBarStyle (const FScrollBarStyle &InScrollBarStyle)
 
void UnlinkColors ()
 
- Public Member Functions inherited from FSlateWidgetStyle
SLATECORE_API FSlateWidgetStyle ()
 
virtual SLATECORE_API ~FSlateWidgetStyle ()
 

Static Public Member Functions

static SLATECORE_API const FEditableTextBoxStyleGetDefault ()
 

Public Attributes

FSlateBrush BackgroundImageNormal
 
FSlateBrush BackgroundImageHovered
 
FSlateBrush BackgroundImageFocused
 
FSlateBrush BackgroundImageReadOnly
 
FMargin Padding
 
FTextBlockStyle TextStyle
 
FSlateColor ForegroundColor
 
FSlateColor BackgroundColor
 
FSlateColor ReadOnlyForegroundColor
 
FSlateColor FocusedForegroundColor
 
FMargin HScrollBarPadding
 
FMargin VScrollBarPadding
 
FScrollBarStyle ScrollBarStyle
 

Static Public Attributes

static SLATECORE_API const FName TypeName
 

Detailed Description

Represents the appearance of an SEditableTextBox

Constructor & Destructor Documentation

◆ FEditableTextBoxStyle() [1/2]

PRAGMA_ENABLE_DEPRECATION_WARNINGS FEditableTextBoxStyle::FEditableTextBoxStyle ( )

◆ FEditableTextBoxStyle() [2/2]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FEditableTextBoxStyle::FEditableTextBoxStyle ( const FEditableTextBoxStyle )
default

◆ ~FEditableTextBoxStyle()

FEditableTextBoxStyle::~FEditableTextBoxStyle ( )
virtualdefault

Member Function Documentation

◆ GetDefault()

const FEditableTextBoxStyle & FEditableTextBoxStyle::GetDefault ( )
static

◆ GetResources()

PRAGMA_ENABLE_DEPRECATION_WARNINGS void FEditableTextBoxStyle::GetResources ( TArray< const FSlateBrush * > &  OutBrushes) const
overridevirtual

Gets the brush resources associated with this style.

This method must be implemented by inherited structures.

Parameters
OutBrushesThe brush resources.

Reimplemented from FSlateWidgetStyle.

◆ GetTypeName()

virtual const FName FEditableTextBoxStyle::GetTypeName ( ) const
inlineoverridevirtual

Gets the name of this style.

This method must be implemented by inherited structures.

Returns
Widget style name.

Reimplemented from FSlateWidgetStyle.

◆ operator=()

FEditableTextBoxStyle & FEditableTextBoxStyle::operator= ( const FEditableTextBoxStyle )
default

◆ SetBackgroundColor()

FEditableTextBoxStyle & FEditableTextBoxStyle::SetBackgroundColor ( const FSlateColor InBackgroundColor)
inline

◆ SetBackgroundImageFocused()

FEditableTextBoxStyle & FEditableTextBoxStyle::SetBackgroundImageFocused ( const FSlateBrush InBackgroundImageFocused)
inline

◆ SetBackgroundImageHovered()

FEditableTextBoxStyle & FEditableTextBoxStyle::SetBackgroundImageHovered ( const FSlateBrush InBackgroundImageHovered)
inline

◆ SetBackgroundImageNormal()

FEditableTextBoxStyle & FEditableTextBoxStyle::SetBackgroundImageNormal ( const FSlateBrush InBackgroundImageNormal)
inline

◆ SetBackgroundImageReadOnly()

FEditableTextBoxStyle & FEditableTextBoxStyle::SetBackgroundImageReadOnly ( const FSlateBrush InBackgroundImageReadOnly)
inline

◆ SetFocusedForegroundColor()

FEditableTextBoxStyle & FEditableTextBoxStyle::SetFocusedForegroundColor ( const FSlateColor InFocusedForegroundColor)
inline

◆ SetFont() [1/2]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FEditableTextBoxStyle & FEditableTextBoxStyle::SetFont ( const FName InFontName,
float  InSize 
)

◆ SetFont() [2/2]

FEditableTextBoxStyle & FEditableTextBoxStyle::SetFont ( const FSlateFontInfo InFont)
inline

◆ SetForegroundColor()

FEditableTextBoxStyle & FEditableTextBoxStyle::SetForegroundColor ( const FSlateColor InForegroundColor)
inline

◆ SetHScrollBarPadding()

FEditableTextBoxStyle & FEditableTextBoxStyle::SetHScrollBarPadding ( const FMargin InPadding)
inline

◆ SetPadding()

FEditableTextBoxStyle & FEditableTextBoxStyle::SetPadding ( const FMargin InPadding)
inline

◆ SetReadOnlyForegroundColor()

FEditableTextBoxStyle & FEditableTextBoxStyle::SetReadOnlyForegroundColor ( const FSlateColor InReadOnlyForegroundColor)
inline

◆ SetScrollBarStyle()

FEditableTextBoxStyle & FEditableTextBoxStyle::SetScrollBarStyle ( const FScrollBarStyle InScrollBarStyle)
inline

◆ SetTextStyle()

FEditableTextBoxStyle & FEditableTextBoxStyle::SetTextStyle ( const FTextBlockStyle InTextStyle)
inline

◆ SetVScrollBarPadding()

FEditableTextBoxStyle & FEditableTextBoxStyle::SetVScrollBarPadding ( const FMargin InPadding)
inline

◆ UnlinkColors()

void FEditableTextBoxStyle::UnlinkColors ( )
inline

Unlinks all colors in this style.

See also
FSlateColor::Unlink

Member Data Documentation

◆ BackgroundColor

FSlateColor FEditableTextBoxStyle::BackgroundColor

The background color applied to the active background image

◆ BackgroundImageFocused

FSlateBrush FEditableTextBoxStyle::BackgroundImageFocused

Border background image when the box is focused

◆ BackgroundImageHovered

FSlateBrush FEditableTextBoxStyle::BackgroundImageHovered

Border background image when the box is hovered

◆ BackgroundImageNormal

FSlateBrush FEditableTextBoxStyle::BackgroundImageNormal

Border background image when the box is not hovered or focused

◆ BackgroundImageReadOnly

FSlateBrush FEditableTextBoxStyle::BackgroundImageReadOnly

Border background image when the box is read-only

◆ FocusedForegroundColor

FSlateColor FEditableTextBoxStyle::FocusedForegroundColor

The foreground color of text when the edit box has keyboard focus.

◆ ForegroundColor

FSlateColor FEditableTextBoxStyle::ForegroundColor

The foreground color of text.

◆ HScrollBarPadding

FMargin FEditableTextBoxStyle::HScrollBarPadding

Padding around the horizontal scrollbar

◆ Padding

FMargin FEditableTextBoxStyle::Padding

Padding

◆ ReadOnlyForegroundColor

FSlateColor FEditableTextBoxStyle::ReadOnlyForegroundColor

The read-only foreground color of text in read-only mode.

◆ ScrollBarStyle

FScrollBarStyle FEditableTextBoxStyle::ScrollBarStyle

Style used for the scrollbars

◆ TextStyle

FTextBlockStyle FEditableTextBoxStyle::TextStyle

The style of the text block, which dictates the font, color, and shadow options. Style overrides all other properties!

◆ TypeName

const FName FEditableTextBoxStyle::TypeName
static

◆ VScrollBarPadding

FMargin FEditableTextBoxStyle::VScrollBarPadding

Padding around the vertical scrollbar


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