FPackagesDialogModule

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IModuleInterface

FPackagesDialogModule

References

Module

PackagesDialog

Header

/Engine/Source/Editor/PackagesDialog/Public/PackagesDialog.h

Include

#include "PackagesDialog.h"

Syntax

class FPackagesDialogModule : public IModuleInterface

Functions

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 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& InOnSourceC...
)

Used to create the package dialog window

Public function Virtual

void

 

GetResults

(
    TArray< UPackage* >& OutPacka...,
    ECheckBoxState InChecked
)

Populates the passed in array with the desired packages

Public function Virtual Const

bool

 

IsWindowInitialized()

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

 

RemoveAllPackageItems()

Removes all package items from the dialog

Public function Virtual

void

 

RemovePackagesDialog()

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

EDialogRetur...

 

ShowPackagesDialog()

Shows the package dialog window as a modal window

Public function Virtual

EDialogRetur...

 

ShowPackagesDialog

(
    OUTTSet< FString >& InOutIgnoredPa...
)

Shows the package dialog window as a modal window

Overridden from IModuleInterface

Name Description

Public function Virtual

void

 

ShutdownModule()

Called before the module is unloaded, right before the module object is destroyed.

Public function Virtual

void

 

StartupModule()

Called right after the module DLL has been loaded and the module object has been created

Public function Virtual

bool

 

SupportsDynamicReloading()

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