Navigation
Unreal Engine C++ API Reference > Developer > Settings
Inheritance Hierarchy
References
Module | Settings |
Header | /Engine/Source/Developer/Settings/Public/ISettingsModule.h |
Include | #include "ISettingsModule.h" |
Syntax
class ISettingsModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)
Remarks
Interface for settings UI modules.
Destructors
Type | Name | Description |
---|---|---|
~ISettingsModule () | Virtual destructor. |
Functions
Type | Name | Description |
---|---|---|
TSharedPtr< ... | GetContainer ( const FName& ContainerName ) | Gets the global settings container with the specified name. |
void | GetContainerNames ( TArray< FName >& OutNames ) | Gets the names of all known setting containers. |
TSharedPtr< ... | RegisterSettings ( const FName& ContainerName, const FName& CategoryName, const FName& SectionName, const FText& DisplayName, const FText& Description, const TWeakObjectPtr< UObject >& S... ) | Adds a settings section to the specified settings container (using a settings object). |
TSharedPtr< ... | RegisterSettings ( const FName& ContainerName, const FName& CategoryName, const FName& SectionName, const FText& DisplayName, const FText& Description, const TSharedRef< SWidget >& Custo... ) | Adds a settings section to the specified settings container (using a custom settings widget). |
void | RegisterViewer ( const FName& ContainerName, ISettingsViewer& SettingsViewer ) | Registers a viewer for the specified settings container. |
void | ShowViewer ( const FName& ContainerName, const FName& CategoryName, const FName& SectionName ) | Shows the settings viewer for the specified settings container. |
void | UnregisterSettings ( const FName& ContainerName, const FName& CategoryName, const FName& SectionName ) | Removes a settings section from the specified settings container. |
void | UnregisterViewer ( const FName& ContainerName ) | Unregisters the currently assigned viewer for the specified settings container. |