IMainFrameModule

Interface for main frame modules.

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

Public function Virtual

~IMainFrameModule()

Virtual destructor.

Functions

Name Description

Public function

void

 

BroadcastMainFrameSDKNotInstalled

(
    const FString & PlatformName,
    const FString & DocLink
)

Public function

void

 

CreateDefaultMainFrame

(
    const bool bStartImmersive,
    const bool bStartPIE
)

Creates the default editor main frame

Public function

void

 

DisableTabClosedDelegate()

Disables the delegate responsible for shutting down the editor when the main tab is closed.

Public function

void

 

EnableTabClosedDelegate()

Enables the delegate responsible for shutting down the editor when the main tab is closed.

Public function Static

IMainFrameMo ...

 

Get()

Gets a reference to the search module instance.

Public function Const

const FText

 

GetApplicationTitle

(
    const bool bIncludeGameName
)

Gets the title string for the application, optionally including the current game name as part of the title

Public function Const

FString

 

GetLoadedLevelName()

Returns a friendly string name for the currently loaded persistent level.

Public function

const TShare ...

 

GetMainFrameCommandBindings()

Public function Const

FMainMRUFavo ...

 

GetMRUFavoritesList()

Gets the MRU/Favorites list

Public function Const

TSharedPtr < ...

 

GetParentWindow()

Gets the window the mainframe lives in.

Public function Const

bool

 

IsWindowInitialized()

Checks to see if the main frame window is currently initialized

Public function Const

TSharedRef < ...

 

MakeDeveloperTools

(
    const TArray < FMainFrameDeveloperTo ...
)

Generates a menu for status and developer

Public function Const

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.

Public function Const

TSharedRef < ...

 

MakeMainTabMenu

(
    const TSharedPtr < FTabManager >& T...,
    const FName MenuName,
    FToolMenuContext & ToolMenuContext
)

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

Public function

FMainFrameCr ...

 

OnMainFrameCreationFinished()

Public function

FMainFrameSD ...

 

OnMainFrameSDKNotInstalled()

Public function

void

 

RecreateDefaultMainFrame

(
    const bool bStartImmersive,
    const bool bStartPIE
)

Recreates the default editor main frame.

Public function

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)

Public function

void

 

SetApplicationTitleOverride

(
    const FText & NewOverriddenApplicat...
)

Overrides the title of the application that's displayed in the title bar area and other locations

Public function

void

 

SetLevelNameForWindowTitle

(
    const FString & InLevelFileName
)

Updates the mainframe title on the Slate window and the native OS window underneath

Public function

void

 

SetMainTab

(
    const TSharedRef < SDockTab >& Main...
)

Sets the reference to the main tab.

Public function Const

void

 

ShowAboutWindow()

Shows the 'About UnrealEd' window.

Classes

Name

Description

Public class

FMainFrameCreationFinishedEvent

Delegate for binding functions to be called when the mainframe finishes up getting created.

Public class

FMainFrameSDKNotInstalled

Delegate for when a platform SDK isn't installed corrected (takes the platform name and the documentation link to show)

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback