UContentBrowserFileDataSource

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

ContentBrowserFileDataSource

Header

/Engine/Plugins/Editor/ContentBrowser/ContentBrowserFileDataSource/Source/ContentBrowserFileDataSource/Public/ContentBrowserFileDataSource.h

Include

#include "ContentBrowserFileDataSource.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UContentBrowserFileDataSource : public UContentBrowserDataSource

Variables

Name Description

Protected variable

TSet< FString >

 

AlwaysVisibleFolders

The set of folders that should always be visible, even if they contain no files in the Content Browser view.

Protected variable

TSharedPtr< FCo...

 

BackgroundDiscovery

Protected variable

ContentBrowserF...

 

Config

Protected variable

TMap< FName, FD...

 

DiscoveredItems

Protected variable

TSet< FString >

 

EmptyFolders

A cache of folders that contain no files in the Content Browser view.

Protected variable

TSortedMap< FNa...

 

RegisteredFileMounts

Functions

Name Description

Protected function

void

 

AddDiscoveredItem

(
    FDiscoveredItem::EType InItemType,
    const FString& InMountPath,
    const FString& InDiskPath,
    const bool bIsRootPath
)

Protected function

void

 

AddDiscoveredItemImpl

(
    FDiscoveredItem::EType InItemType,
    const FString& InMountPath,
    const FString& InDiskPath,
    const FName InChildMountPathName,
    const bool bIsRootPath
)

Public function

void

 

AddFileMount

(
    const FName InFileMountPath,
    const FString& InFileMountDiskPath
)

Protected function

FContentBrow...

 

CreateFileItem

(
    const FName InInternalPath,
    const FString& InFilename
)

Protected function

FContentBrow...

 

CreateFolderItem

(
    const FName InInternalPath,
    const FString& InFilename
)

Protected function

FContentBrow...

 

CreateItemFromDiscovered

(
    const FName InInternalPath,
    const FDiscoveredItem& InDiscovere...
)

Protected function Const

TSharedPtr< ...

 

GetFileItemPayload

(
    const FContentBrowserItemData& InI...
)

Protected function Const

TSharedPtr< ...

 

GetFolderItemPayload

(
    const FContentBrowserItemData& InI...
)

Public function

void

 

Initialize

(
    const FName InMountRoot,
    const ContentBrowserFileData::FFile...,
    const bool InAutoRegister
)

Protected function Const

bool

 

IsKnownFileMount

(
    const FName InMountPath,
    FString* OutDiskPath
)

Protected function Const

bool

 

IsRootFileMount

(
    const FName InMountPath,
    FString* OutDiskPath
)

Protected function

void

 

OnAlwaysShowPath

(
    const FStringView InPath
)

Protected function

void

 

OnAlwaysShowPath

(
    const FName InPath
)

Protected function

void

 

OnDirectoryChanged

(
    const TArray< FFileChangeData >& I...,
    const FString InFileMountPath,
    const FString InFileMountDiskPath
)

Called when a file in a watched directory changes on disk

Protected function

FContentBrow...

 

OnFinalizeCreateFile

(
    const FContentBrowserItemData& InI...,
    const FString& InProposedName,
    FText* OutErrorMsg
)

Protected function

FContentBrow...

 

OnFinalizeCreateFolder

(
    const FContentBrowserItemData& InI...,
    const FString& InProposedName,
    FText* OutErrorMsg
)

Protected function

FContentBrow...

 

OnFinalizeDuplicateFile

(
    const FContentBrowserItemData& InI...,
    const FString& InProposedName,
    FText* OutErrorMsg
)

Protected function

void

 

OnNewFileRequested

(
    const FName InDestFolderPath,
    const FString InDestFolder,
    TSharedRef< const ContentBrowserFil...,
    UContentBrowserDataMenuContext_AddN...
)

Protected function

void

 

OnPathPopulated

(
    const FStringView InPath
)

Protected function

void

 

OnPathPopulated

(
    const FName InPath
)

Protected function

bool

 

OnValidateItemName

(
    const FContentBrowserItemData& InI...,
    const FString& InProposedName,
    FText* OutErrorMsg
)

Protected function

void

 

PopulateAddNewContextMenu

(
    UToolMenu* InMenu
)

Protected function

void

 

RemoveDiscoveredItem

(
    const FString& InMountPath
)

Protected function

void

 

RemoveDiscoveredItem

(
    const FName InMountPath
)

Protected function

void

 

RemoveDiscoveredItemImpl

(
    const FName InMountPath,
    const bool bParentIsOrphan
)

Public function

void

 

RemoveFileMount

(
    const FName InFileMountPath
)

Overridden from UContentBrowserDataSource

Name Description

Public function Virtual

bool

 

BulkCopyItems

(
    TArrayView< const FContentBrowserIt...,
    const FName InDestPath
)

Attempt to copy the given items to the given virtual path.

Public function Virtual

bool

 

BulkDeleteItems

(
    TArrayView< const FContentBrowserIt...
)

Attempt to delete the given items.

Public function Virtual

bool

 

BulkDuplicateItems

(
    TArrayView< const FContentBrowserIt...,
    TArray< FContentBrowserItemData >&...
)

Attempt to synchronously duplicate the given items.

Public function Virtual

bool

 

BulkEditItems

(
    TArrayView< const FContentBrowserIt...
)

Attempt to open the given item for editing.

Public function Virtual

bool

 

BulkMoveItems

(
    TArrayView< const FContentBrowserIt...,
    const FName InDestPath
)

Attempt to move the given items to the given virtual path.

Public function Virtual

bool

 

BulkPreviewItems

(
    TArrayView< const FContentBrowserIt...
)

Attempt to preview the given items.

Public function Virtual

bool

 

CanCopyItem

(
    const FContentBrowserItemData& InI...,
    const FName InDestPath,
    FText* OutErrorMsg
)

Query whether the given item is can be copied, optionally providing error information if it cannot.

Public function Virtual

bool

 

CanCreateFolder

(
    const FName InPath,
    FText* OutErrorMsg
)

Query whether a folder can be created at the given virtual path, optionally providing error information if it cannot.

Public function Virtual

bool

 

CanDeleteItem

(
    const FContentBrowserItemData& InI...,
    FText* OutErrorMsg
)

Query whether the given item is can be deleted, optionally providing error information if it cannot.

Public function Virtual

bool

 

CanDuplicateItem

(
    const FContentBrowserItemData& InI...,
    FText* OutErrorMsg
)

Query whether the given item is can be duplicated, optionally providing error information if it cannot.

Public function Virtual

bool

 

CanEditItem

(
    const FContentBrowserItemData& InI...,
    FText* OutErrorMsg
)

Query whether the given item is can be edited, optionally providing error information if it cannot.

Public function Virtual

bool

 

CanMoveItem

(
    const FContentBrowserItemData& InI...,
    const FName InDestPath,
    FText* OutErrorMsg
)

Query whether the given item is can be moved, optionally providing error information if it cannot.

Public function Virtual

bool

 

CanPreviewItem

(
    const FContentBrowserItemData& InI...,
    FText* OutErrorMsg
)

Query whether the given item is can be previewed, optionally providing error information if it cannot.

Public function Virtual

bool

 

CanRenameItem

(
    const FContentBrowserItemData& InI...,
    const FString* InNewName,
    FText* OutErrorMsg
)

Query whether the given item is can be renamed, optionally providing error information if it cannot.

Public function Virtual

void

 

CompileFilter

(
    const FName InPath,
    const FContentBrowserDataFilter& I...,
    FContentBrowserDataCompiledFilter&...
)

Given a path and a data filter, produce an optimized filter that can be used to efficiently enumerate items that match it, and also query whether an item would pass it.

Public function Virtual

bool

 

CopyItem

(
    const FContentBrowserItemData& InI...,
    const FName InDestPath
)

Attempt to copy the given item to the given virtual path.

Public function Virtual

bool

 

CreateFolder

(
    const FName InPath,
    FContentBrowserItemDataTemporaryCon...
)

Attempt to begin the process of asynchronously creating a folder at the given virtual path, populating a temporary item that can be finalized or canceled by the user.

Public function Virtual

bool

 

DeleteItem

(
    const FContentBrowserItemData& InI...
)

Attempt to delete the given item.

Public function Virtual

bool

 

DoesItemPassFilter

(
    const FContentBrowserItemData& InI...,
    const FContentBrowserDataCompiledFi...
)

Query whether the given item passes the given compiled filter.

Public function Virtual

bool

 

DuplicateItem

(
    const FContentBrowserItemData& InI...,
    FContentBrowserItemDataTemporaryCon...
)

Attempt to begin the process of asynchronously duplicating the given item, populating a temporary item that can be finalized or canceled by the user.

Public function Virtual

bool

 

EditItem

(
    const FContentBrowserItemData& InI...
)

Attempt to open the given item for editing.

Public function Virtual

void

 

EnumerateItemsAtPath

(
    const FName InPath,
    const EContentBrowserItemTypeFilter...,
    TFunctionRef< bool...
)

Enumerate items that have the given virtual path, optionally filtering by type, and invoking the callback for each matching item.

Public function Virtual

void

 

EnumerateItemsMatchingFilter

(
    const FContentBrowserDataCompiledFi...,
    TFunctionRef< bool...
)

Enumerate items that match the given compiled filter, invoking the callback for each matching item.

Protected function Virtual

void

 

EnumerateRootPaths

(
    const FContentBrowserDataFilter& I...,
    TFunctionRef< void)> InCallba...
)

Iterate over each of the root paths in this data source.

Public function Virtual

bool

 

GetItemAttribute

(
    const FContentBrowserItemData& InI...,
    const bool InIncludeMetaData,
    const FName InAttributeKey,
    FContentBrowserItemDataAttributeVal...
)

Query the value of the given attribute on the given item.

Public function Virtual

bool

 

GetItemAttributes

(
    const FContentBrowserItemData& InI...,
    const bool InIncludeMetaData,
    FContentBrowserItemDataAttributeVal...
)

Query the values of all attributes on the given item.

Public function Virtual

bool

 

GetItemPhysicalPath

(
    const FContentBrowserItemData& InI...,
    FString& OutDiskPath
)

Query the physical (on-disk) path of the given item.

Public function Virtual

bool

 

IsDiscoveringItems

(
    FText* OutStatus
)

Query whether this data source instance is currently discovering content, and retrieve an optional status message that can be shown in the UI.

Public function Virtual

bool

 

IsFolderVisibleIfHidingEmpty

(
    const FName InPath
)

Query whether the given virtual folder should be visible if the UI is asking to hide empty content folders.

Public function Virtual

bool

 

MoveItem

(
    const FContentBrowserItemData& InI...,
    const FName InDestPath
)

Attempt to move the given item to the given virtual path.

Public function Virtual

bool

 

PreviewItem

(
    const FContentBrowserItemData& InI...
)

Attempt to preview the given item.

Public function Virtual

bool

 

PrioritizeSearchPath

(
    const FName InPath
)

If possible, attempt to prioritize content discovery for the given virtual path.

Public function Virtual

bool

 

RenameItem

(
    const FContentBrowserItemData& InI...,
    const FString& InNewName,
    FContentBrowserItemData& OutNewIte...
)

Attempt to rename the given item.

Public function Virtual

void

 

Shutdown()

Shutdown this data source instance.

Public function Virtual

void

 

Tick

(
    const float InDeltaTime
)

Tick this data source instance.

Public function Virtual

bool

 

UpdateThumbnail

(
    const FContentBrowserItemData& InI...,
    FAssetThumbnail& InThumbnail
)

Attempt to update the thumbnail associated with the given item.

Classes

Name

Description

Protected struct

FDiscoveredItem

Protected struct

FFileMount
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss