1. Epic GamesDeveloper
  3. UContentBrowserFileDataSource

UContentBrowserFileDataSource

API > API/Plugins > API/Plugins/ContentBrowserFileDataSource

Inheritance Hierarchy

References

   
Module ContentBrowserFileDataSource
Header /Engine/Plugins/Editor/ContentBrowser/ContentBrowserFileDataSource/Source/ContentBrowserFileDataSource/Public/ContentBrowserFileDataSource.h
Include #include "ContentBrowserFileDataSource.h"

Syntax

UCLASS&40;&41;  
class UContentBrowserFileDataSource : public UContentBrowserDataSource

Variables

  Type 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< FContentBrowserFileDataDiscovery > BackgroundDiscovery  
Protected variable ContentBrowserFileData::FFileConfigData Config  
Protected variable TMap< FName, FDiscoveredItem > DiscoveredItems  
Protected variable TSet< FString > EmptyFolders A cache of folders that contain no files in the Content Browser view.
Protected variable TArray< TSharedRef< IAssetTypeActions > > RegisteredAssetTypeActions  
Protected variable TMap< FName, TArray< FName > > RegisteredFileMountRoots  
Protected variable TSortedMap< FName, FFileMount, FDefaultAllocator, FNameFastLess > RegisteredFileMounts  

Functions

  Type 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 FContentBrowserItemData

CreateFileItem ( const FName InInternalPath,
const FString& InFilename
)

  
Protected function FContentBrowserItemData

CreateFolderItem ( const FName InInternalPath,
const FString& InFilename
)

  
Protected function FContentBrowserItemData

CreateItemFromDiscovered ( const FName InInternalPath,
const FDiscoveredItem& InDiscoveredItem
)

  
Protected function Const TSharedPtr< const FContentBrowserFileItemDataPayload >  
Protected function Const TSharedPtr< const FContentBrowserFolderItemDataPayload >  
Public function Const bool

HasFileMount ( const FName InFileMountPath
)

  
Public function void

Initialize ( const ContentBrowserFileData::FFileConfigData& InConfig,
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 >& InFileChanges,
const FString InFileMountPath,
const FString InFileMountDiskPath
)

 Called when a file in a watched directory changes on disk
Protected function FContentBrowserItemData

OnFinalizeCreateFile ( const FContentBrowserItemData& InItemData,
const FString& InProposedName,
FText* OutErrorMsg
)

  
Protected function FContentBrowserItemData

OnFinalizeCreateFolder ( const FContentBrowserItemData& InItemData,
const FString& InProposedName,
FText* OutErrorMsg
)

  
Protected function FContentBrowserItemData

OnFinalizeDuplicateFile ( const FContentBrowserItemData& InItemData,
const FString& InProposedName,
FText* OutErrorMsg
)

  
Protected function void

OnNewFileRequested ( const FName InDestFolderPath,
const FString InDestFolder,
TSharedRef< const ContentBrowserFileData::FFileActions > InFileActions,
UContentBrowserDataMenuContext_AddNewMenu::FOnBeginItemCreation InOnBeginItemCreation
)

  
Protected function void

OnPathPopulated ( const FStringView InPath
)

  
Protected function void

OnPathPopulated ( const FName InPath
)

  
Protected function bool

OnValidateItemName ( const FContentBrowserItemData& InItem,
const FString& InProposedName,
FText* OutErrorMsg
)

  
Protected function Static bool

PassesFilters ( const FStringView InPath,
const FDiscoveredItem& InDiscoveredItem,
const int32 InFolderDepthChecked,
const FContentBrowserCompiledFileDataFilter& InFileDataFilter
)

  
Protected function Const bool

PassesFilters ( const FName InPath,
const int32 InFolderDepthChecked,
const FContentBrowserCompiledFileDataFilter& InFileDataFilter
)

  
Protected function void  
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

  Type Name Description
Public function Virtual void Rebuilds the tree of virtual paths that ends with internal roots
Public function Virtual bool

BulkCopyItems ( TArrayView< const FContentBrowserItemData > InItems,
const FName InDestPath
)

 Attempt to copy the given items to the given virtual path.
Public function Virtual bool Attempt to delete the given items.
Public function Virtual bool Attempt to synchronously duplicate the given items.
Public function Virtual bool Attempt to open the given item for editing.
Public function Virtual bool

BulkMoveItems ( TArrayView< const FContentBrowserItemData > InItems,
const FName InDestPath
)

 Attempt to move the given items to the given virtual path.
Public function Virtual bool Attempt to preview the given items.
Public function Virtual bool

CanCopyItem ( const FContentBrowserItemData& InItem,
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& InItem,
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& InItem,
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& InItem,
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& InItem,
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& InItem,
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& InItem,
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& InFilter,
FContentBrowserDataCompiledFilter& OutCompiledFilter
)

 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& InItem,
const FName InDestPath
)

 Attempt to copy the given item to the given virtual path.
Public function Virtual bool

CreateFolder ( const FName InPath,
FContentBrowserItemDataTemporaryContext& OutPendingItem
)

 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 Attempt to delete the given item.
Public function Virtual bool Query whether the given item passes the given compiled filter.
Public function Virtual bool 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& InItem
)

 Attempt to open the given item for editing.
Public function Virtual void

EnumerateItemsAtPath ( const FName InPath,
const EContentBrowserItemTypeFilter InItemTypeFilter,
TFunctionRef< bool(FContentBrowserItemData&&)> InCallback
)

 Enumerate items that have the given virtual path, optionally filtering by type, and invoking the callback for each matching item.
Public function Virtual void Enumerate items that match the given compiled filter, invoking the callback for each matching item.
Public function Virtual bool

GetItemAttribute ( const FContentBrowserItemData& InItem,
const bool InIncludeMetaData,
const FName InAttributeKey,
FContentBrowserItemDataAttributeValue& OutAttributeValue
)

 Query the value of the given attribute on the given item.
Public function Virtual bool

GetItemAttributes ( const FContentBrowserItemData& InItem,
const bool InIncludeMetaData,
FContentBrowserItemDataAttributeValues& OutAttributeValues
)

 Query the values of all attributes on the given item.
Public function Virtual bool

GetItemPhysicalPath ( const FContentBrowserItemData& InItem,
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

IsFolderVisible ( const FName InPath,
const EContentBrowserIsFolderVisibleFlags InFlags
)

 Query whether the given virtual folder should be visible in the UI.
Public function Virtual bool

MoveItem ( const FContentBrowserItemData& InItem,
const FName InDestPath
)

 Attempt to move the given item to the given virtual path.
Public function Virtual bool 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& InItem,
const FString& InNewName,
FContentBrowserItemData& OutNewItem
)

 Attempt to rename the given item.
Public function Virtual void 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& InItem,
FAssetThumbnail& InThumbnail
)

 Attempt to update the thumbnail associated with the given item.

Classes

  Type Name Description
Protected struct FDiscoveredItem    
Protected struct FFileMount    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page