Navigation
API > API/Editor > API/Editor/MainFrame
Interface for main frame modules.
| Name | IMainFrameModule |
| Type | class |
| Header File | /Engine/Source/Editor/MainFrame/Public/Interfaces/IMainFrameModule.h |
| Include Path | #include "Interfaces/IMainFrameModule.h" |
Syntax
class IMainFrameModule : public IModuleInterface
Implements Interfaces
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IMainFrameModule() |
Virtual destructor. | Interfaces/IMainFrameModule.h |
Classes
| Name | Remarks |
|---|---|
| FMainFrameCreationFinishedEvent | Delegate for binding functions to be called when the mainframe finishes up getting created. |
| FMainFrameRequestResource | Delegate for making an open-ended request for a resource or link. |
| FMainFrameSDKNotInstalled | Delegate for when a platform SDK isn't installed corrected (takes the platform name and the documentation link to show) |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FMainFrameCanCloseEditor | TBaseDelegate_NoParams< bool > | Delegate for determining if the editor can be closed | Interfaces/IMainFrameModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BroadcastMainFrameRequestResource
(
const FString& Category, |
Interfaces/IMainFrameModule.h | ||
void BroadcastMainFrameSDKNotInstalled
(
const FString& PlatformName, |
Interfaces/IMainFrameModule.h | ||
void CreateDefaultMainFrame
(
const bool bStartImmersive, |
Creates the default editor main frame | Interfaces/IMainFrameModule.h | |
void DisableTabClosedDelegate() |
Disables the delegate responsible for shutting down the editor when the main tab is closed. | Interfaces/IMainFrameModule.h | |
void EnableDelayedShowMainFrame() |
Enable external control of when main frame is shown | Interfaces/IMainFrameModule.h | |
void EnableTabClosedDelegate() |
Enables the delegate responsible for shutting down the editor when the main tab is closed. | Interfaces/IMainFrameModule.h | |
bool ExecuteCanCloseEditorDelegates() |
Interfaces/IMainFrameModule.h | ||
const FText GetApplicationTitle
(
const bool bIncludeGameName |
Gets the title string for the application, optionally including the current game name as part of the title | Interfaces/IMainFrameModule.h | |
void GetEditorSettingsDefaultSelectionOverride
(
FName& OutCategoryName, |
Gets the override for the section that gets selected by default when opening editor settings | Interfaces/IMainFrameModule.h | |
FString GetLoadedLevelName() |
Returns a friendly string name for the currently loaded persistent level. | Interfaces/IMainFrameModule.h | |
TSharedRef< FUICommandList > & GetMainFrameCommandBindings() |
Interfaces/IMainFrameModule.h | ||
FMainMRUFavoritesList * GetMRUFavoritesList() |
Gets the MRU/Favorites list | Interfaces/IMainFrameModule.h | |
TSharedPtr< SWindow > GetParentWindow() |
Gets the window the mainframe lives in. | Interfaces/IMainFrameModule.h | |
bool IsRecreatingDefaultMainFrame() |
Returns true if the Default Main Frame is being recreated. | Interfaces/IMainFrameModule.h | |
bool IsWindowInitialized() |
Checks to see if the main frame window is currently initialized | Interfaces/IMainFrameModule.h | |
TSharedRef< SWidget > MakeDeveloperTools
(
const TArray< FMainFrameDeveloperTool >& AdditionalTools |
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 | Interfaces/IMainFrameModule.h | |
TSharedRef< SWidget > MakeMainMenu
(
const TSharedPtr< FTabManager >& TabManager, |
Generates a menu that includes application global commands, such as "Save All", "Exit", etc. | Interfaces/IMainFrameModule.h | |
FMainFrameCreationFinishedEvent & OnMainFrameCreationFinished() |
Interfaces/IMainFrameModule.h | ||
FMainFrameRequestResource & OnMainFrameRequestResource() |
Interfaces/IMainFrameModule.h | ||
FMainFrameSDKNotInstalled & OnMainFrameSDKNotInstalled() |
Interfaces/IMainFrameModule.h | ||
void RecreateDefaultMainFrame
(
const bool bStartImmersive, |
Recreates the default editor main frame. | Interfaces/IMainFrameModule.h | |
FDelegateHandle RegisterCanCloseEditor
(
const FMainFrameCanCloseEditor& InDelegate |
Register a new callback for determining if the editor can be closed | Interfaces/IMainFrameModule.h | |
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) | Interfaces/IMainFrameModule.h | |
void SetApplicationTitleOverride
(
const FText& NewOverriddenApplicationTitle |
Overrides the title of the application that's displayed in the title bar area and other locations | Interfaces/IMainFrameModule.h | |
void SetEditorSettingsDefaultSelectionOverride
(
FName CategoryName, |
Overrides the section that gets selected by default when opening editor settings | Interfaces/IMainFrameModule.h | |
void SetLevelNameForWindowTitle
(
const FString& InLevelFileName |
Updates the mainframe title on the Slate window and the native OS window underneath | Interfaces/IMainFrameModule.h | |
void SetMainTab
(
const TSharedRef< SDockTab >& MainTab |
Sets the reference to the main tab. | Interfaces/IMainFrameModule.h | |
void ShowAboutWindow() |
Shows the 'About UnrealEd' window. | Interfaces/IMainFrameModule.h | |
void ShowDelayedMainFrame() |
Show main frame now if it was delayed and not shown yet | Interfaces/IMainFrameModule.h | |
void UnregisterCanCloseEditor
(
FDelegateHandle InHandle |
Unregister a callback for determining if the editor can be closed | Interfaces/IMainFrameModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IMainFrameModule & Get() |
Gets a reference to the search module instance. | Interfaces/IMainFrameModule.h |