Navigation
API > API/Runtime > API/Runtime/SlateCore
Represents the appearance of an SSearchBox
| Name | FSearchBoxStyle |
| Type | struct |
| Header File | /Engine/Source/Runtime/SlateCore/Public/Styling/SlateTypes.h |
| Include Path | #include "Styling/SlateTypes.h" |
Syntax
USTRUCT ()
struct FSearchBoxStyle : public FSlateWidgetStyle
Inheritance Hierarchy
- FSlateWidgetStyle → FSearchBoxStyle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSearchBoxStyle() |
Styling/SlateTypes.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FSearchBoxStyle() |
Styling/SlateTypes.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| TypeName | const FName | Styling/SlateTypes.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveFontInfo | FSlateFontInfo | Font to use for the text box part of the search box when a search term is entered | Styling/SlateTypes.h |
|
| bLeftAlignGlassImageAndClearButton | bool | If true, glass image and clear button appear to the left of the search text | Styling/SlateTypes.h |
|
| bLeftAlignSearchResultButtons | bool | If true, search result buttons appear to the left of the search text | Styling/SlateTypes.h |
|
| ClearImage | FSlateBrush | Image to use for the search "clear" button | Styling/SlateTypes.h |
|
| DownArrowImage | FSlateBrush | Image to use for the search "down" arrow | Styling/SlateTypes.h |
|
| GlassImage | FSlateBrush | Image to use for the search "glass" | Styling/SlateTypes.h |
|
| ImagePadding | FMargin | Padding to use around the images | Styling/SlateTypes.h |
|
| ImageSizeOverride | TOptional< FVector2D > | Size of the images (auto size if not set) | Styling/SlateTypes.h |
|
| TextBoxStyle | FEditableTextBoxStyle | Style to use for the text box part of the search box | Styling/SlateTypes.h |
|
| UpArrowImage | FSlateBrush | Image to use for the search "up" arrow | Styling/SlateTypes.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSearchBoxStyle & SetActiveFont
(
const FSlateFontInfo& InFontInfo |
Styling/SlateTypes.h | ||
FSearchBoxStyle & SetClearImage
(
const FSlateBrush& InClearImage |
Styling/SlateTypes.h | ||
FSearchBoxStyle & SetDownArrowImage
(
const FSlateBrush& InDownArrowImage |
Styling/SlateTypes.h | ||
FSearchBoxStyle & SetGlassImage
(
const FSlateBrush& InGlassImage |
Styling/SlateTypes.h | ||
FSearchBoxStyle & SetImagePadding
(
const FMargin& InImagePadding |
Styling/SlateTypes.h | ||
FSearchBoxStyle & SetImageSizeOverride
(
const TOptional< FVector2D >& InImageSizeOverride |
Styling/SlateTypes.h | ||
FSearchBoxStyle & SetLeftAlignButtons
(
bool bInLeftAlignButtons |
Styling/SlateTypes.h | ||
FSearchBoxStyle & SetLeftAlignGlassImageAndClearButton
(
bool bInLeftAlignGlassImageAndClearButton |
Styling/SlateTypes.h | ||
FSearchBoxStyle & SetLeftAlignSearchResultButtons
(
bool bInLeftAlignSearchResultButtons |
Styling/SlateTypes.h | ||
FSearchBoxStyle & SetTextBoxStyle
(
const FEditableTextBoxStyle& InTextBoxStyle |
Styling/SlateTypes.h | ||
FSearchBoxStyle & SetUpArrowImage
(
const FSlateBrush& InUpArrowImage |
Styling/SlateTypes.h |
Overridden from FSlateWidgetStyle
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GetResources
(
TArray< const FSlateBrush* >& OutBrushes |
Gets the brush resources associated with this style. | Styling/SlateTypes.h | |
virtual const FName GetTypeName() |
Gets the name of this style.This method must be implemented by inherited structures. | Styling/SlateTypes.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const FSearchBoxStyle & GetDefault() |
Styling/SlateTypes.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bLeftAlignButtons_DEPRECATED | bool | If true, buttons appear to the left of the search text | Styling/SlateTypes.h |
|