Navigation
API > API/Developer > API/Developer/Settings
Interface for setting sections.
A setting section is a collection of settings that logically belong together (i.e. all settings for a console platform). Internally, the individual settings are represented as the properties of an UObject. One or more setting sections can the be hierarchically arranged in a setting category.
| Name | ISettingsSection |
| Type | class |
| Header File | /Engine/Source/Developer/Settings/Public/ISettingsSection.h |
| Include Path | #include "ISettingsSection.h" |
Syntax
class ISettingsSection
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ISettingsSection() |
Virtual destructor. | ISettingsSection.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnCanEdit | TBaseDelegate_NoParams< bool > | A delegate that is executed to check whether a settings section can be edited. | ISettingsSection.h |
| FOnExport | TBaseDelegate_OneParam< bool, const FString & > | A delegate that is executed when a settings section should export its values to a file. | ISettingsSection.h |
| FOnImport | TBaseDelegate_OneParam< bool, const FString & > | A delegate that is executed when a settings section should import its values from a file. | ISettingsSection.h |
| FOnModified | TBaseDelegate_NoParams< bool > | A delegate that is executed when a settings section has been modified. | ISettingsSection.h |
| FOnResetDefaults | TBaseDelegate_NoParams< bool > | A delegate that is executed when a settings section should have its values reset to default. | ISettingsSection.h |
| FOnSave | TBaseDelegate_NoParams< bool > | A delegate that is executed when a settings section should have its values saved. | ISettingsSection.h |
| FOnSaveDefaults | TBaseDelegate_NoParams< bool > | A delegate that is executed when a settings section should have its values saved as default. | ISettingsSection.h |
| FOnSelect | TBaseDelegate_NoParams< void > | A delegate that is executed to check whether a settings section can be edited. | ISettingsSection.h |
| FOnStatus | TBaseDelegate_NoParams< FText > | A delegate that is executed to retrieve a status message for a settings section. | ISettingsSection.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanEdit() |
Checks whether this section can be edited right now. | ISettingsSection.h | |
bool CanExport() |
Checks whether this section can export its settings to a file. | ISettingsSection.h | |
bool CanImport() |
Checks whether this section can import its settings from a file. | ISettingsSection.h | |
bool CanResetDefaults() |
Checks whether this section can have its settings reset to default. | ISettingsSection.h | |
bool CanSave () |
Checks whether this section can have its settings saved. | ISettingsSection.h | |
bool CanSaveDefaults() |
Checks whether this section can have its settings saved as default. | ISettingsSection.h | |
bool Export
(
const FString& Filename |
Exports the settings in this section to the specified file. | ISettingsSection.h | |
TWeakPtr< ISettingsCategory > GetCategory() |
Gets the settings category that this section belongs to. | ISettingsSection.h | |
TWeakPtr< SWidget > GetCustomWidget() |
Gets the custom settings widget for this settings section. | ISettingsSection.h | |
const FText & GetDescription() |
Gets the section's localized description text. | ISettingsSection.h | |
const FText & GetDisplayName() |
Gets the section's localized display name. | ISettingsSection.h | |
const FName & GetName() |
Gets the section's name. | ISettingsSection.h | |
TWeakObjectPtr< UObject > GetSettingsObject() |
Gets the UObject holding the section's settings. | ISettingsSection.h | |
FText GetStatus() |
Gets the section's optional status text. | ISettingsSection.h | |
bool HasDefaultSettingsObject() |
Checks whether this section holds a settings object that saves directly to default configuration files. | ISettingsSection.h | |
bool Import
(
const FString& Filename |
Imports the settings in this section from the specified file. | ISettingsSection.h | |
bool NotifySectionOnPropertyModified() |
Notifies a section that a single property has been modified | ISettingsSection.h | |
FOnCanEdit & OnCanEdit() |
ISettingsSection.h | ||
FOnExport & OnExport() |
ISettingsSection.h | ||
FOnImport & OnImport() |
ISettingsSection.h | ||
FOnModified & OnModified() |
ISettingsSection.h | ||
FOnResetDefaults & OnResetDefaults() |
ISettingsSection.h | ||
FOnSave & OnSave() |
ISettingsSection.h | ||
FOnSaveDefaults & OnSaveDefaults() |
ISettingsSection.h | ||
FOnSelect & OnSelect() |
ISettingsSection.h | ||
FOnStatus & OnStatus() |
ISettingsSection.h | ||
bool ResetDefaults() |
Resets the settings in this section to their default value. | ISettingsSection.h | |
bool Save() |
Saves the settings in this section. | ISettingsSection.h | |
bool SaveDefaults() |
Saves the settings in this section as defaults. | ISettingsSection.h | |
void Select() |
Called when the current section is selected. | ISettingsSection.h |