Navigation
API > API/Developer > API/Developer/Settings
Interface for setting containers.
A settings container is a collection of setting categories. Each category holds a collection of setting sections, which contain the actual settings in the form of UObject properties.
| Name | ISettingsContainer |
| Type | class |
| Header File | /Engine/Source/Developer/Settings/Public/ISettingsContainer.h |
| Include Path | #include "ISettingsContainer.h" |
Syntax
class ISettingsContainer
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ISettingsContainer() |
Virtual destructor. | ISettingsContainer.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnCategoryModified | TMulticastDelegate_OneParam< void, const FName & > | A delegate that is executed when a settings category has been added or modified. | ISettingsContainer.h |
| FOnSectionRemoved | TMulticastDelegate_OneParam< void, const TSharedRef< ISettingsSection > & > | A delegate that is executed when a settings section has been removed. | ISettingsContainer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Updates the details of this settings container. | ISettingsContainer.h | ||
| Updates the details of the specified settings category. | ISettingsContainer.h | ||
int32 GetCategories
(
TArray< TSharedPtr< ISettingsCategory > >& OutCategories |
Gets the setting categories. | ISettingsContainer.h | |
TSharedPtr< ISettingsCategory > GetCategory
(
const FName& CategoryName |
Gets the category with the specified name. | ISettingsContainer.h | |
const FText & GetDescription() |
Gets the container's localized description text. | ISettingsContainer.h | |
const FText & GetDisplayName() |
Gets the container's localized display name. | ISettingsContainer.h | |
const FName & GetIconName() |
Gets the name of the container's icon. | ISettingsContainer.h | |
const FName & GetName() |
Gets the container's name. | ISettingsContainer.h | |
FOnCategoryModified & OnCategoryModified() |
ISettingsContainer.h | ||
FOnSectionRemoved & OnSectionRemoved() |
ISettingsContainer.h | ||
void ResetCategorySortPriority
(
FName CategoryName |
Resets the sort priority of a category to its default value Sort priority | ISettingsContainer.h | |
void SetCategorySortPriority
(
FName CategoryName, |
Sets the sort priority of a category A lower priority value means the category is listed first The priority value is 0 by default | ISettingsContainer.h |