1. Epic GamesDeveloper
  3. IMainFrameModule

IMainFrameModule

Interface for main frame modules.

API > API/Editor > API/Editor/MainFrame > API/Editor/MainFrame/Interfaces

Inheritance Hierarchy

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

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Public function void

BroadcastMainFrameRequestResource ( const FString& Category,
const FString& ResourceName
)

  
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 Disables the delegate responsible for shutting down the editor when the main tab is closed.
Public function void Enable external control of when main frame is shown
Public function void Enables the delegate responsible for shutting down the editor when the main tab is closed.
Public function bool  
Public function Static IMainFrameModule &

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 void

GetEditorSettingsDefaultSelectionOverride ( FName& OutCategoryName,
FName& OutSectionName
)

 Gets the override for the section that gets selected by default when opening editor settings
Public function Const FString Returns a friendly string name for the currently loaded persistent level.
Public function TSharedRef< FUICommandList > &  
Public function Const FMainMRUFavoritesList * Gets the MRU/Favorites list
Public function Const TSharedPtr< SWindow > Gets the window the mainframe lives in.
Public function Const bool Returns true if the Default Main Frame is being recreated.
Public function Const bool Checks to see if the main frame window is currently initialized
Public function Const 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
Public function Const TSharedRef< SWidget >

MakeMainMenu ( const TSharedPtr< FTabManager >& TabManager,
const FName MenuName,
FToolMenuContext& ToolMenuContext
)

 Generates a menu that includes application global commands, such as "Save All", "Exit", etc.
Public function FMainFrameCreationFinishedEvent &  
Public function FMainFrameRequestResource &  
Public function FMainFrameSDKNotInstalled &  
Public function void

RecreateDefaultMainFrame ( const bool bStartImmersive,
const bool bStartPIE
)

 Recreates the default editor main frame.
Public function FDelegateHandle Register a new callback for determining if the editor can be closed
Public function void 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& NewOverriddenApplicationTitle
)

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

SetEditorSettingsDefaultSelectionOverride ( FName CategoryName,
FName SectionName
)

 Overrides the section that gets selected by default when opening editor settings
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 >& MainTab
)

 Sets the reference to the main tab.
Public function Const void Shows the 'About UnrealEd' window.
Public function void Show main frame now if it was delayed and not shown yet
Public function void Unregister a callback for determining if the editor can be closed

Classes

  Type Name Description
Public class FMainFrameCreationFinishedEvent Delegate for binding functions to be called when the mainframe finishes up getting created.  
Public class FMainFrameRequestResource Delegate for making an open-ended request for a resource or link.  
Public class 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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page