Navigation
API > API/Developer > API/Developer/Settings
References
| Module | Settings |
| Header | /Engine/Source/Developer/Settings/Public/ISettingsSection.h |
| Include | #include "ISettingsSection.h" |
Syntax
class ISettingsSection
Remarks
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.
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Virtual destructor. |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
bool | CanEdit () |
Checks whether this section can be edited right now. |
  |
bool | CanExport () |
Checks whether this section can export its settings to a file. |
  |
bool | CanImport () |
Checks whether this section can import its settings from a file. |
  |
bool | Checks whether this section can have its settings reset to default. | |
  |
bool | CanSave () |
Checks whether this section can have its settings saved. |
  |
bool | Checks whether this section can have its settings saved as default. | |
 |
bool | Exports the settings in this section to the specified file. | |
 |
TWeakPtr< ISettingsCategory > | GetCategory () |
Gets the settings category that this section belongs to. |
  |
TWeakPtr< SWidget > | Gets the custom settings widget for this settings section. | |
  |
const FText & | Gets the section's localized description text. | |
  |
const FText & | Gets the section's localized display name. | |
  |
const FName & | GetName () |
Gets the section's name. |
  |
TWeakObjectPtr< UObject > | Gets the UObject holding the section's settings. | |
  |
FText | GetStatus () |
Gets the section's optional status text. |
 |
bool | Checks whether this section holds a settings object that saves directly to default configuration files. | |
 |
bool | Imports the settings in this section from the specified file. | |
 |
bool | Notifies a section that a single property has been modified | |
 |
FOnCanEdit & | OnCanEdit () |
|
 |
FOnExport & | OnExport () |
|
 |
FOnImport & | OnImport () |
|
 |
FOnModified & | OnModified () |
|
 |
FOnResetDefaults & | ||
 |
FOnSave & | OnSave () |
|
 |
FOnSaveDefaults & | ||
 |
FOnSelect & | OnSelect () |
|
 |
FOnStatus & | OnStatus () |
|
 |
bool | Resets the settings in this section to their default value. | |
 |
bool | Save () |
Saves the settings in this section. |
 |
bool | SaveDefaults () |
Saves the settings in this section as defaults. |
 |
void | Select () |
Called when the current section is selected. |
Typedefs
| Name | Description |
|---|---|
| FOnCanEdit | A delegate that is executed to check whether a settings section can be edited. |
| FOnExport | A delegate that is executed when a settings section should export its values to a file. |
| FOnImport | A delegate that is executed when a settings section should import its values from a file. |
| FOnModified | A delegate that is executed when a settings section has been modified. |
| FOnResetDefaults | A delegate that is executed when a settings section should have its values reset to default. |
| FOnSave | A delegate that is executed when a settings section should have its values saved. |
| FOnSaveDefaults | A delegate that is executed when a settings section should have its values saved as default. |
| FOnSelect | A delegate that is executed to check whether a settings section can be edited. |
| FOnStatus | A delegate that is executed to retrieve a status message for a settings section. |