ISettingsEditorModule

Interface for settings editor modules.

API > API/Developer > API/Developer/SettingsEditor

Interface for settings editor modules.

   
Name ISettingsEditorModule
Type class
Header File /Engine/Source/Developer/SettingsEditor/Public/ISettingsEditorModule.h
Include Path #include "ISettingsEditorModule.h"

Syntax

class ISettingsEditorModule : public IModuleInterface

Implements Interfaces

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ISettingsEditorModule()

 Virtual destructor. ISettingsEditorModule.h  

Structs

Name Remarks
FSearchTerm  

Typedefs

Name Type Remarks Include Path
FOnSearchTermsChanged TMulticastDelegate_TwoParams< void, FName, const FString & > Delegate called when new search terms have been registered ISettingsEditorModule.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSharedRef< SWidget > CreateEditor ( const TSharedRef< ISettingsEditorModel >& Model
)

 Creates a settings editor widget. ISettingsEditorModule.h  

TSharedRef< ISettingsEditorModel > CreateModel ( const TSharedRef< ISettingsContainer >& SettingsContainer
)

 Creates a view model for the settings editor widget. ISettingsEditorModule.h  

FSearchTerm * FindSearchTerm ( FName InContainerName,
const FString& InKey
)

 Finds existing search term for a specific container and key ISettingsEditorModule.h  

const FSearchTerm * FindSearchTerm ( FName InContainerName,
const FString& InKey
) const

 Finds existing search term for a specific container and key (const version) ISettingsEditorModule.h  

const TMap< FString, FSearchTerm > * FindSearchTerms ( FName InContainerName
) const

 Finds existing search terms for a specific container ISettingsEditorModule.h  

void OnApplicationRestartRequired()

 Called when the settings have been changed such that an application restart is required for them to be fully applied ISettingsEditorModule.h  

FOnSearchTermsChanged::RegistrationType & OnSearchTermsChanged()

   ISettingsEditorModule.h  

bool RegisterSearchTerm ( FName InContainerName,
const FString& InKey
)

 Registers a search term for a specific container and key, does nothing if it already exists ISettingsEditorModule.h  

void SetRestartApplicationCallback ( FSimpleDelegate InRestartApplicationDelegate
)

 Set the delegate that should be called when a setting editor needs to restart the application ISettingsEditorModule.h  

void SetShouldRegisterSettingCallback ( FShouldRegisterSettingsDelegate InShouldRegisterSettingDelegate
)

 Set the delegate that should be called when a setting editor checks whether a settings object should be registered. ISettingsEditorModule.h  

void UpdateSettings ( bool bForce
)

 Registers any pending auto-discovered settings. ISettingsEditorModule.h  

Public Virtual

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page