Navigation
API > API/Runtime > API/Runtime/AppFramework
The widget that manages the dropdown menu in the Color Themes Panel
| Name | SColorThemesViewer |
| Type | class |
| Header File | /Engine/Source/Runtime/AppFramework/Public/Widgets/Colors/SColorThemes.h |
| Include Path | #include "Widgets/Colors/SColorThemes.h" |
Syntax
class SColorThemesViewer : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SColorThemesViewer
- FSlateControlledConstruction → SWidget → SCompoundWidget → SColorThemesViewer
Classes
| Name | Remarks |
|---|---|
| FCurrentThemeChangedEvent | Callbacks to execute whenever we change the global current theme |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| bSRGBEnabled | bool | Widgets/Colors/SColorThemes.h | |
| ColorThemes | TArray< TSharedPtr< FColorTheme > > | A static holder of the color themes for the entire program | Widgets/Colors/SColorThemes.h |
| CurrentlySelectedThemePtr | TWeakPtr< FColorTheme > | A static pointer to the color theme that is currently selected for the entire program | Widgets/Colors/SColorThemes.h |
| Recents | TSharedPtr< FColorTheme > | A static color theme comprised of the most recently accepted color values | Widgets/Colors/SColorThemes.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bUseAlpha | TAttribute< bool > | Whether or not the color uses Alpha or not | Widgets/Colors/SColorThemes.h | |
| CurrentThemeChangedEvent | FCurrentThemeChangedEvent | Callbacks to execute whenever we change the global current theme | Widgets/Colors/SColorThemes.h | |
| MultiBoxWidget | TSharedPtr< SMultiBoxWidget > | The MultiBox widget of the combo button | Widgets/Colors/SColorThemes.h | |
| RenameTextBox | TSharedPtr< SEditableTextBox > | The text box for renaming themes | Widgets/Colors/SColorThemes.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Widgets/Colors/SColorThemes.h | ||
TSharedPtr< FColorTheme > GetCurrentColorTheme() |
Gets the current color theme | Widgets/Colors/SColorThemes.h | |
TSharedPtr< FColorTheme > GetRecents() |
Gets the recents color theme | Widgets/Colors/SColorThemes.h | |
bool IsRecentsThemeActive() |
Returns true if the currently chosen theme is the "Recents" theme | Widgets/Colors/SColorThemes.h | |
void MenuToStandardNoReturn() |
Widgets/Colors/SColorThemes.h | ||
FCurrentThemeChangedEvent & OnCurrentThemeChanged() |
Widgets/Colors/SColorThemes.h | ||
void SetUseAlpha
(
const TAttribute< bool >& InUseAlpha |
Widgets/Colors/SColorThemes.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedPtr< FColorTheme > GetColorTheme
(
const FString& ThemeName |
Gets the color theme, creates it if not present | Widgets/Colors/SColorThemes.h | |
static TSharedPtr< FColorTheme > GetDefaultColorTheme
(
bool bCreateNew |
Gets the default color theme, optionally creates it if not present | Widgets/Colors/SColorThemes.h | |
static TSharedPtr< FColorTheme > IsColorTheme
(
const FString& ThemeName |
Checks to see if this is a color theme, returns success | Widgets/Colors/SColorThemes.h | |
static void LoadColorThemesFromIni() |
Load the color theme settings from the config | Widgets/Colors/SColorThemes.h | |
| Makes the passed theme name unique so it doesn't clash with pre-existing themes | Widgets/Colors/SColorThemes.h | ||
static TSharedPtr< FColorTheme > NewColorTheme
(
const FString& ThemeName, |
Creates a new theme, ensuring the name is unique | Widgets/Colors/SColorThemes.h | |
static void SaveColorThemesToIni() |
Save the color theme settings to the config | Widgets/Colors/SColorThemes.h |