1. Epic GamesDeveloper
  3. FPackagesDialogModule

FPackagesDialogModule

API > API/Editor > API/Editor/PackagesDialog

Inheritance Hierarchy

References

   
Module PackagesDialog
Header /Engine/Source/Editor/PackagesDialog/Public/PackagesDialog.h
Include #include "PackagesDialog.h"

Syntax

class FPackagesDialogModule : public IModuleInterface

Functions

  Type Name Description
Public function Virtual void

AddButton ( EDialogReturnType Type,
const FText& Name,
const FText& ToolTip,
TAttribute< bool > Disabled
)

 Adds a new button to the package dialog windowAdds a new button to the package dialog window
Public function Virtual void

AddButton ( EDialogReturnType Type,
EDialogButtonStyle ButtonStyle,
const FText& Name,
const FText& ToolTip,
TAttribute< bool > Disabled
)

 Adds a new button to the package dialog window
Public function Virtual void

AddPackageItem ( UPackage* InPackage,
ECheckBoxState InChecked,
bool InDisabled,
FString InIconName,
FString InIconToolTip
)

 Adds a new item to the checkbox that represents a package
Public function Virtual void

CreatePackagesDialog ( const FText& Title,
const FText& Message,
bool InReadOnly,
bool InAllowSourceControlConnection,
const FSimpleDelegate& InOnSourceControlStateChanged
)

 Used to create the package dialog window
Public function Virtual void

GetResults ( TArray< UPackage* >& OutPackages,
ECheckBoxState InChecked
)

 Populates the passed in array with the desired packages
Public function Virtual Const bool Checks to see if the package dialog window is currently initialized
Protected function void

OnModulesChanged ( FName ModuleThatChanged,
EModuleChangeReason ReasonForChange
)

 Called when a module has been changed (unloaded, loaded, etc)
Public function Virtual void Removes all package items from the dialog
Public function Virtual void Removes the package dialog window
Public function Virtual void

SetMessage ( const FText& InMessage
)

 Sets the message displayed in the package dialog
Public function Virtual void

SetWarning ( const FText& InMessage
)

 Sets the warning message displayed in the package dialog
Public function Virtual EDialogReturnType Shows the package dialog window as a modal window
Public function Virtual EDialogReturnType

ShowPackagesDialog ( TSet< FString >& InOutIgnoredPackages
)

 Shows the package dialog window as a modal window

Overridden from IModuleInterface

  Type Name Description
Public function Virtual void Called before the module is unloaded, right before the module object is destroyed.
Public function Virtual void Called right after the module DLL has been loaded and the module object has been created
Public function Virtual bool Override this to set whether your module is allowed to be unloaded on the fly

Constants

Name Description
DEFAULT_WINDOW_SIZE A default window size for the package dialog
EXTRA_WINDOW_WIDTH Extra window width if source control connection is allowed

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page