1. Epic GamesDeveloper
  3. FSearchBoxStyle

FSearchBoxStyle

Represents the appearance of an [SSearchBox](API\Runtime\Slate\Widgets\Input\SSearchBox)

API > API/Runtime > API/Runtime/SlateCore > API/Runtime/SlateCore/Styling

Inheritance Hierarchy

References

   
Module SlateCore
Header /Engine/Source/Runtime/SlateCore/Public/Styling/SlateTypes.h
Include #include "Styling/SlateTypes.h"

Syntax

struct FSearchBoxStyle : public FSlateWidgetStyle

Remarks

Represents the appearance of an SSearchBox

Variables

  Type Name Description
Public variable FSlateFontInfo ActiveFontInfo Font to use for the text box part of the search box when a search term is entered
Public variable bool bLeftAlignGlassImageAndClearButton If true, glass image and clear button appear to the left of the search text
Public variable bool bLeftAlignSearchResultButtons If true, search result buttons appear to the left of the search text
Public variable FSlateBrush ClearImage Image to use for the search "clear" button
Public variable FSlateBrush DownArrowImage Image to use for the search "down" arrow
Public variable FSlateBrush GlassImage Image to use for the search "glass"
Public variable FMargin ImagePadding Padding to use around the images
Public variable FEditableTextBoxStyle TextBoxStyle Style to use for the text box part of the search box
Public variable FSlateBrush UpArrowImage Image to use for the search "up" arrow

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static const FSearchBoxStyle &  
Public function FSearchBoxStyle &

SetActiveFont ( const FSlateFontInfo& InFontInfo
)

  
Public function FSearchBoxStyle &

SetClearImage ( const FSlateBrush& InClearImage
)

  
Public function FSearchBoxStyle &

SetDownArrowImage ( const FSlateBrush& InDownArrowImage
)

  
Public function FSearchBoxStyle &

SetGlassImage ( const FSlateBrush& InGlassImage
)

  
Public function FSearchBoxStyle &

SetImagePadding ( const FMargin& InImagePadding
)

  
Public function FSearchBoxStyle &

SetLeftAlignButtons ( bool bInLeftAlignButtons
)

  
Public function FSearchBoxStyle &

SetLeftAlignGlassImageAndClearButton ( bool bInLeftAlignGlassImageAndClearButton
)

  
Public function FSearchBoxStyle &

SetLeftAlignSearchResultButtons ( bool bInLeftAlignSearchResultButtons
)

  
Public function FSearchBoxStyle &

SetTextBoxStyle ( const FEditableTextBoxStyle& InTextBoxStyle
)

  
Public function FSearchBoxStyle &

SetUpArrowImage ( const FSlateBrush& InUpArrowImage
)

  

Overridden from FSlateWidgetStyle

  Type Name Description
Public function Virtual Const void

GetResources ( TArray< const FSlateBrush* >& OutBrushes
)

 Gets the brush resources associated with this style.
Public function Virtual Const const FName Gets the name of this style.This method must be implemented by inherited structures.

Constants

Name Description
TypeName  

Deprecated Variables

  Type Name Description
Public variable bool bLeftAlignButtons_DEPRECATED If true, buttons appear to the left of the search text

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page