Navigation
API > API/Runtime > API/Runtime/AppFramework
A panel for displaying SColorBlocks in a FColorTheme
| Name | SThemeColorBlocksBar |
| Type | class |
| Header File | /Engine/Source/Runtime/AppFramework/Public/Widgets/Colors/SColorThemes.h |
| Include Path | #include "Widgets/Colors/SColorThemes.h" |
Syntax
class SThemeColorBlocksBar : public SPanel
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SPanel → SThemeColorBlocksBar
- FSlateControlledConstruction → SWidget → SPanel → SThemeColorBlocksBar
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
SThemeColorBlocksBar() |
Widgets/Colors/SColorThemes.h |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnGetActiveColor | TBaseDelegate_NoParams< FLinearColor > | Delegate for hooking up to an inline editable text block 'IsSelected' check. | Widgets/Colors/SColorThemes.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AddDeleteOverlay | TSharedPtr< SOverlay > | Overlay widget that shows either the add button or the delete button | Widgets/Colors/SColorThemes.h | |
| bShowDeleteButton | bool | Whether or not the delete button is currently visible | Widgets/Colors/SColorThemes.h | |
| bUseAlpha | TAttribute< bool > | Whether or not the color uses Alpha or not | Widgets/Colors/SColorThemes.h | |
| bUseSRGB | TAttribute< bool > | Whether to use display sRGB color | Widgets/Colors/SColorThemes.h | |
| Children | TSlotlessChildren< SWidget > | The children blocks of this panel | Widgets/Colors/SColorThemes.h | |
| ColorBlocks | TArray< TSharedPtr< SThemeColorBlock > > | Array of color blocks belonging to the currently selected color theme | Widgets/Colors/SColorThemes.h | |
| ColorTheme | TSharedPtr< FColorTheme > | The Color Theme that this SThemeColorBlockBar is displaying. | Widgets/Colors/SColorThemes.h | |
| DragShadow | TSharedPtr< SBorder > | Placeholder widget to show where a dropped color block will be added to the color theme | Widgets/Colors/SColorThemes.h | |
| OnGetActiveColor | FOnGetActiveColor | Event called to retrieve the current color from the color picker | Widgets/Colors/SColorThemes.h | |
| OnSelectColor | FOnLinearColorValueChanged | Event called when a color block is clicked | Widgets/Colors/SColorThemes.h | |
| PlaceholderIndex | TOptional< int32 > | Index in the panel indicating where the drag shadow placeholder widget should be drawn | Widgets/Colors/SColorThemes.h | |
| RefreshCallback | FSimpleDelegate | Callback to pass to the Color Theme. Holds a handle to this bar's Refresh method | Widgets/Colors/SColorThemes.h | |
| RefreshCallbackHandle | FDelegateHandle | Handle to the registered RefreshCallback delegate | Widgets/Colors/SColorThemes.h | |
| ThemesViewer | TSharedPtr< SColorThemesViewer > | Custom combo button widget featuring a menu with the list of color themes and actions related to those themes | Widgets/Colors/SColorThemes.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddNewColorBlock
(
FLinearColor Color, |
Adds a new color block to the Bar | Widgets/Colors/SColorThemes.h | |
void AddRefreshCallback() |
Widgets/Colors/SColorThemes.h | ||
void AddToRecents
(
FLinearColor Color |
Adds a new color block to the Recents color theme | Widgets/Colors/SColorThemes.h | |
void Construct
(
const FArguments& InArgs |
Widgets/Colors/SColorThemes.h | ||
void HideDeleteButton() |
Hide the delete button and make the add button visible | Widgets/Colors/SColorThemes.h | |
bool IsRecentsThemeActive() |
Returns true if the currently selected theme is Recents | Widgets/Colors/SColorThemes.h | |
void Refresh() |
Rebuilds the entire bar, regenerating all the constituent color blocks | Widgets/Colors/SColorThemes.h | |
int32 RemoveColorBlock
(
TSharedPtr< FLinearColor > ColorToRemove |
Widgets/Colors/SColorThemes.h | ||
void RemoveRefreshCallback() |
Widgets/Colors/SColorThemes.h | ||
void SetPlaceholderGrabOffset
(
FVector2D GrabOffset |
Widgets/Colors/SColorThemes.h | ||
void ShowDeleteButton() |
Make the delete button visible and hide the add button | Widgets/Colors/SColorThemes.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FVector2D ComputeDesiredSize
(
float |
Widgets/Colors/SColorThemes.h | ||
virtual FChildren * GetChildren() |
Widgets/Colors/SColorThemes.h | ||
virtual void OnArrangeChildren
(
const FGeometry& AllottedGeometry, |
Widgets/Colors/SColorThemes.h | ||
virtual void OnDragEnter
(
const FGeometry& MyGeometry, |
Widgets/Colors/SColorThemes.h | ||
virtual void OnDragLeave
(
const FDragDropEvent& DragDropEvent |
Widgets/Colors/SColorThemes.h | ||
virtual FReply OnDragOver
(
const FGeometry& MyGeometry, |
Widgets/Colors/SColorThemes.h | ||
virtual FReply OnDrop
(
const FGeometry& MyGeometry, |
Widgets/Colors/SColorThemes.h |