Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > MainFrame > Interfaces > IMainFrameModule

Light Theme

Dark Theme

IMainFrameModule

Interface for main frame modules.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IModuleInterface

IMainFrameModule

References

Module	MainFrame
Header	/Engine/Source/Editor/MainFrame/Public/Interfaces/IMainFrameModule.h
Include	#include "Interfaces/IMainFrameModule.h"

Syntax

class IMainFrameModule : public IModuleInterface

Remarks

Interface for main frame modules.

Destructors

	Name	Description
	~IMainFrameModule()	Virtual destructor.

Functions

	Name	Description
void	BroadcastMainFrameSDKNotInstalled ( const FString& PlatformName, const FString& DocLink )
void	CreateDefaultMainFrame ( const bool bStartImmersive, const bool bStartPIE )	Creates the default editor main frame
void	DisableTabClosedDelegate()	Disables the delegate responsible for shutting down the editor when the main tab is closed.
void	EnableDelayedShowMainFrame()	Enable external control of when main frame is shown
void	EnableTabClosedDelegate()	Enables the delegate responsible for shutting down the editor when the main tab is closed.
bool	ExecuteCanCloseEditorDelegates()
IMainFrameMo...	Get()	Gets a reference to the search module instance.
const FText	GetApplicationTitle ( const bool bIncludeGameName )	Gets the title string for the application, optionally including the current game name as part of the title
FString	GetLoadedLevelName()	Returns a friendly string name for the currently loaded persistent level.
TSharedRef< ...	GetMainFrameCommandBindings()
FMainMRUFavo...	GetMRUFavoritesList()	Gets the MRU/Favorites list
TSharedPtr< ...	GetParentWindow()	Gets the window the mainframe lives in.
bool	IsRecreatingDefaultMainFrame()	Returns true if the Default Main Frame is being recreated.
bool	IsWindowInitialized()	Checks to see if the main frame window is currently initialized
TSharedRef< ...	MakeDeveloperTools ( const TArray< FMainFrameDeveloperTo... )	Generates a menu that's just like the "main menu" widget above, except it also includes some infrequently used commands that are better off only shown in a single "main tab" within the application
TSharedRef< ...	MakeMainMenu ( const TSharedPtr< FTabManager >& T..., const FName MenuName, FToolMenuContext& ToolMenuContext )	Generates a menu that includes application global commands, such as "Save All", "Exit", etc.
FMainFrameCr...	OnMainFrameCreationFinished()
FMainFrameSD...	OnMainFrameSDKNotInstalled()
void	RecreateDefaultMainFrame ( const bool bStartImmersive, const bool bStartPIE )	Recreates the default editor main frame.
FDelegateHan...	RegisterCanCloseEditor ( const FMainFrameCanCloseEditor& In... )	Register a new callback for determining if the editor can be closed
void	RequestCloseEditor()	Requests that the editor be closed In some cases the editor may not be closed (like if a user cancels a save dialog)
void	SetApplicationTitleOverride ( const FText& NewOverriddenApplicat... )	Overrides the title of the application that's displayed in the title bar area and other locations
void	SetLevelNameForWindowTitle ( const FString& InLevelFileName )	Updates the mainframe title on the Slate window and the native OS window underneath
void	SetMainTab ( const TSharedRef< SDockTab >& Main... )	Sets the reference to the main tab.
void	ShowAboutWindow()	Shows the 'About UnrealEd' window.
void	ShowDelayedMainFrame()	Show main frame now if it was delayed and not shown yet
void	UnregisterCanCloseEditor ( FDelegateHandle InHandle )	Unregister a callback for determining if the editor can be closed

Classes

	Name	Description
	FMainFrameCreationFinishedEvent	Delegate for binding functions to be called when the mainframe finishes up getting created.
	FMainFrameSDKNotInstalled	Delegate for when a platform SDK isn't installed corrected (takes the platform name and the documentation link to show)

Typedefs

Name	Description
FMainFrameCanCloseEditor	Delegate for determining if the editor can be closed