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

#include <SlateTypes.h>

+ Inheritance diagram for FSearchBoxStyle:

Public Member Functions

SLATECORE_API FSearchBoxStyle ()
 
virtual SLATECORE_API ~FSearchBoxStyle ()
 
virtual SLATECORE_API void GetResources (TArray< const FSlateBrush * > &OutBrushes) const override
 
virtual const FName GetTypeName () const override
 
SLATECORE_API FSearchBoxStyleSetTextBoxStyle (const FEditableTextBoxStyle &InTextBoxStyle)
 
FSearchBoxStyleSetActiveFont (const FSlateFontInfo &InFontInfo)
 
FSearchBoxStyleSetUpArrowImage (const FSlateBrush &InUpArrowImage)
 
FSearchBoxStyleSetDownArrowImage (const FSlateBrush &InDownArrowImage)
 
FSearchBoxStyleSetGlassImage (const FSlateBrush &InGlassImage)
 
FSearchBoxStyleSetClearImage (const FSlateBrush &InClearImage)
 
FSearchBoxStyleSetImagePadding (const FMargin &InImagePadding)
 
FSearchBoxStyleSetImageSizeOverride (const TOptional< FVector2D > &InImageSizeOverride)
 
SLATECORE_API FSearchBoxStyleSetLeftAlignButtons (bool bInLeftAlignButtons)
 
FSearchBoxStyleSetLeftAlignSearchResultButtons (bool bInLeftAlignSearchResultButtons)
 
FSearchBoxStyleSetLeftAlignGlassImageAndClearButton (bool bInLeftAlignGlassImageAndClearButton)
 
- Public Member Functions inherited from FSlateWidgetStyle
SLATECORE_API FSlateWidgetStyle ()
 
virtual SLATECORE_API ~FSlateWidgetStyle ()
 

Static Public Member Functions

static SLATECORE_API const FSearchBoxStyleGetDefault ()
 

Public Attributes

FEditableTextBoxStyle TextBoxStyle
 
FSlateFontInfo ActiveFontInfo
 
FSlateBrush UpArrowImage
 
FSlateBrush DownArrowImage
 
FSlateBrush GlassImage
 
FSlateBrush ClearImage
 
FMargin ImagePadding
 
TOptional< FVector2DImageSizeOverride
 
bool bLeftAlignButtons_DEPRECATED
 
bool bLeftAlignSearchResultButtons
 
bool bLeftAlignGlassImageAndClearButton
 

Static Public Attributes

static SLATECORE_API const FName TypeName
 

Detailed Description

Represents the appearance of an SSearchBox

Constructor & Destructor Documentation

◆ FSearchBoxStyle()

FSearchBoxStyle::FSearchBoxStyle ( )

◆ ~FSearchBoxStyle()

FSearchBoxStyle::~FSearchBoxStyle ( )
virtualdefault

Member Function Documentation

◆ GetDefault()

const FSearchBoxStyle & FSearchBoxStyle::GetDefault ( )
static

◆ GetResources()

void FSearchBoxStyle::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 FSearchBoxStyle::GetTypeName ( ) const
inlineoverridevirtual

Gets the name of this style.

This method must be implemented by inherited structures.

Returns
Widget style name.

Reimplemented from FSlateWidgetStyle.

◆ SetActiveFont()

FSearchBoxStyle & FSearchBoxStyle::SetActiveFont ( const FSlateFontInfo InFontInfo)
inline

◆ SetClearImage()

FSearchBoxStyle & FSearchBoxStyle::SetClearImage ( const FSlateBrush InClearImage)
inline

◆ SetDownArrowImage()

FSearchBoxStyle & FSearchBoxStyle::SetDownArrowImage ( const FSlateBrush InDownArrowImage)
inline

◆ SetGlassImage()

FSearchBoxStyle & FSearchBoxStyle::SetGlassImage ( const FSlateBrush InGlassImage)
inline

◆ SetImagePadding()

FSearchBoxStyle & FSearchBoxStyle::SetImagePadding ( const FMargin InImagePadding)
inline

◆ SetImageSizeOverride()

FSearchBoxStyle & FSearchBoxStyle::SetImageSizeOverride ( const TOptional< FVector2D > &  InImageSizeOverride)
inline

◆ SetLeftAlignButtons()

FSearchBoxStyle & FSearchBoxStyle::SetLeftAlignButtons ( bool  bInLeftAlignButtons)

◆ SetLeftAlignGlassImageAndClearButton()

FSearchBoxStyle & FSearchBoxStyle::SetLeftAlignGlassImageAndClearButton ( bool  bInLeftAlignGlassImageAndClearButton)
inline

◆ SetLeftAlignSearchResultButtons()

FSearchBoxStyle & FSearchBoxStyle::SetLeftAlignSearchResultButtons ( bool  bInLeftAlignSearchResultButtons)
inline

◆ SetTextBoxStyle()

FSearchBoxStyle & FSearchBoxStyle::SetTextBoxStyle ( const FEditableTextBoxStyle InTextBoxStyle)

◆ SetUpArrowImage()

FSearchBoxStyle & FSearchBoxStyle::SetUpArrowImage ( const FSlateBrush InUpArrowImage)
inline

Member Data Documentation

◆ ActiveFontInfo

FSlateFontInfo FSearchBoxStyle::ActiveFontInfo

Font to use for the text box part of the search box when a search term is entered

◆ bLeftAlignButtons_DEPRECATED

bool FSearchBoxStyle::bLeftAlignButtons_DEPRECATED

If true, buttons appear to the left of the search text

◆ bLeftAlignGlassImageAndClearButton

bool FSearchBoxStyle::bLeftAlignGlassImageAndClearButton

If true, glass image and clear button appear to the left of the search text

◆ bLeftAlignSearchResultButtons

bool FSearchBoxStyle::bLeftAlignSearchResultButtons

If true, search result buttons appear to the left of the search text

◆ ClearImage

FSlateBrush FSearchBoxStyle::ClearImage

Image to use for the search "clear" button

◆ DownArrowImage

FSlateBrush FSearchBoxStyle::DownArrowImage

Image to use for the search "down" arrow

◆ GlassImage

FSlateBrush FSearchBoxStyle::GlassImage

Image to use for the search "glass"

◆ ImagePadding

FMargin FSearchBoxStyle::ImagePadding

Padding to use around the images

◆ ImageSizeOverride

TOptional<FVector2D> FSearchBoxStyle::ImageSizeOverride

Size of the images (auto size if not set)

◆ TextBoxStyle

FEditableTextBoxStyle FSearchBoxStyle::TextBoxStyle

Style to use for the text box part of the search box

◆ TypeName

const FName FSearchBoxStyle::TypeName
static

◆ UpArrowImage

FSlateBrush FSearchBoxStyle::UpArrowImage

Image to use for the search "up" arrow


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