Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > ContentBrowserData > UContentBrowserDataSource

Light Theme

Dark Theme

UContentBrowserDataSource

A common implementation of a "do nothing" data source for the Content Browser.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UContentBrowserDataSource

	UContentBrowserAssetDataSource
	UContentBrowserClassDataSource
	UContentBrowserFileDataSource

References

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

Syntax

class UContentBrowserDataSource :
public UObject,
public IModularFeature

Remarks

A common implementation of a "do nothing" data source for the Content Browser. You should derive from this type to create new data sources for the Content Browser, overriding any required functionality and validation logic.

Data sources create and operate on FContentBrowserItemData instances that represent the folders and files within each data source. FContentBrowserItemData itself is a concrete type, so extensibility is handled via the IContentBrowserItemDataPayload interface, which can be used to store any data source defined payload data that is required to operate on the underlying thing that the item represents.

This is the only API you need to implement to create a data source, as each FContentBrowserItemData instance knows which data source owns it, and uses that information to pass itself back into the correct data source instance when asked to perform actions or validation. In that sense you can think of this like a C API, where the data source returns an opaque object that is later passed back into the data source functions so that they can interpret the opaque object and provide functionality for it.

Functions

	Name	Description
bool	AppendItemReference ( const FContentBrowserItemData& InI..., FString& InOutStr )	Attempt to append any path references for the given item to the given string.
bool	BulkCopyItems ( TArrayView< const FContentBrowserIt..., const FName InDestPath )	Attempt to copy the given items to the given virtual path.
bool	BulkDeleteItems ( TArrayView< const FContentBrowserIt... )	Attempt to delete the given items.
bool	BulkDuplicateItems ( TArrayView< const FContentBrowserIt..., TArray< FContentBrowserItemData >&... )	Attempt to synchronously duplicate the given items.
bool	BulkEditItems ( TArrayView< const FContentBrowserIt... )	Attempt to open the given item for editing.
bool	BulkMoveItems ( TArrayView< const FContentBrowserIt..., const FName InDestPath )	Attempt to move the given items to the given virtual path.
bool	BulkPreviewItems ( TArrayView< const FContentBrowserIt... )	Attempt to preview the given items.
bool	BulkSaveItems ( TArrayView< const FContentBrowserIt..., const EContentBrowserItemSaveFlags ... )	Attempt to save the given items.
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.
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.
bool	CanDeleteItem ( const FContentBrowserItemData& InI..., FText* OutErrorMsg )	Query whether the given item is can be deleted, optionally providing error information if it cannot.
bool	CanDuplicateItem ( const FContentBrowserItemData& InI..., FText* OutErrorMsg )	Query whether the given item is can be duplicated, optionally providing error information if it cannot.
bool	CanEditItem ( const FContentBrowserItemData& InI..., FText* OutErrorMsg )	Query whether the given item is can be edited, optionally providing error information if it cannot.
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.
bool	CanPreviewItem ( const FContentBrowserItemData& InI..., FText* OutErrorMsg )	Query whether the given item is can be previewed, optionally providing error information if it cannot.
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.
bool	CanSaveItem ( const FContentBrowserItemData& InI..., const EContentBrowserItemSaveFlags ..., FText* OutErrorMsg )	Query whether the given item is can be saved, optionally providing error information if it cannot.
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.
bool	CopyItem ( const FContentBrowserItemData& InI..., const FName InDestPath )	Attempt to copy the given item to the given virtual path.
TSharedPtr< ...	CreateCustomDragOperation ( TArrayView< const FContentBrowserIt... )	Called to provide custom drag and drop handling when starting a drag event.
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.
bool	DeleteItem ( const FContentBrowserItemData& InI... )	Attempt to delete the given item.
bool	DoesItemPassFilter ( const FContentBrowserItemData& InI..., const FContentBrowserDataCompiledFi... )	Query whether the given item passes the given compiled filter.
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.
bool	EditItem ( const FContentBrowserItemData& InI... )	Attempt to open the given item for editing.
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.
void	EnumerateItemsMatchingFilter ( const FContentBrowserDataCompiledFi..., TFunctionRef< bool... )	Enumerate items that match the given compiled filter, invoking the callback for each matching item.
void	EnumerateRootPaths ( const FContentBrowserDataFilter& I..., TFunctionRef< void)> InCallba... )	Iterate over each of the root paths in this data source.
void	ExpandVirtualPath ( const FName InPath, const FContentBrowserDataFilter& I..., FName& OutInternalPath, TSet< FName >& OutInternalPaths, TMap< FName, TArray< FName >>& Out... )	Convert virtual path to one or more internal paths and any number of virtual paths Example: The "/All" virtual path corresponds to more than one internal root paths such as "/Game" and possibly multiple virtual paths such as "/All/Plugins"
bool	GetItemAttribute ( const FContentBrowserItemData& InI..., const bool InIncludeMetaData, const FName InAttributeKey, FContentBrowserItemDataAttributeVal... )	Query the value of the given attribute on the given item.
bool	GetItemAttributes ( const FContentBrowserItemData& InI..., const bool InIncludeMetaData, FContentBrowserItemDataAttributeVal... )	Query the values of all attributes on the given item.
bool	GetItemPhysicalPath ( const FContentBrowserItemData& InI..., FString& OutDiskPath )	Query the physical (on-disk) path of the given item.
FName	GetModularFeatureTypeName()	Get the name used when registering data source modular feature instances for use with the Content Browser Data Subsystem.
FName	GetVirtualMountRoot()	Get the virtual mount root that was passed to Initialize.
TArrayView< ...	GetVirtualMountRootHierarchy()	Get the virtual folder paths required to get to the virtual mount root of this data source instance.
bool	HandleDragDropOnItem ( const FContentBrowserItemData& InI..., const FDragDropEvent& InDragDropEv... )	Called to provide custom drag and drop handling when a drag event is dropped on an item.
bool	HandleDragEnterItem ( const FContentBrowserItemData& InI..., const FDragDropEvent& InDragDropEv... )	Called to provide custom drag and drop handling when a drag event enters an item, such as performing validation and reporting error information.
bool	HandleDragLeaveItem ( const FContentBrowserItemData& InI..., const FDragDropEvent& InDragDropEv... )	Called to provide custom drag and drop handling when a drag event leaves an item, such as clearing any error information set during earlier validation.
bool	HandleDragOverItem ( const FContentBrowserItemData& InI..., const FDragDropEvent& InDragDropEv... )	Called to provide custom drag and drop handling while a drag event is over an item, such as performing validation and reporting error information.
void	Initialize ( const FName InMountRoot, const bool InAutoRegister )	Initialize this data source instance, optionally registering it once the initialization has finished (
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.
bool	IsFolderVisibleIfHidingEmpty ( const FName InPath )	Query whether the given virtual folder should be visible if the UI is asking to hide empty content folders.
bool	IsInitialized()	True if this data source is currently initialized.
bool	IsItemDirty ( const FContentBrowserItemData& InI... )	Query whether the given item is considered dirty (ie, has unsaved changes).
bool	IsVirtualPathUnderMountRoot ( const FName InPath )	Test whether the given virtual path is under the virtual mount root that was passed to Initialize.
bool	Legacy_TryConvertAssetDataToVirtualPath ( const FAssetData& InAssetData, const bool InUseFolderPaths, FName& OutPath )	Attempt to convert the given asset data to a virtual path associated with this data source.
bool	Legacy_TryConvertPackagePathToVirtualPath ( const FName InPackagePath, FName& OutPath )	Attempt to convert the given package path to a virtual path associated with this data source.
bool	Legacy_TryGetAssetData ( const FContentBrowserItemData& InI..., FAssetData& OutAssetData )	Attempt to retrieve the asset data associated with the given item.
bool	Legacy_TryGetPackagePath ( const FContentBrowserItemData& InI..., FName& OutPackagePath )	Attempt to retrieve the package path associated with the given item.
bool	MoveItem ( const FContentBrowserItemData& InI..., const FName InDestPath )	Attempt to move the given item to the given virtual path.
void	NotifyItemDataRefreshed()	Notify a wholesale item data update, for data sources that can't provide delta-updates.
bool	PreviewItem ( const FContentBrowserItemData& InI... )	Attempt to preview the given item.
bool	PrioritizeSearchPath ( const FName InPath )	If possible, attempt to prioritize content discovery for the given virtual path.
void	QueueItemDataUpdate ( FContentBrowserItemDataUpdate&& In... )	Queue an incremental item data update, for data sources that can provide delta-updates.
void	RegisterDataSource()	Register this data source instance for use with the Content Browser Data Subsystem.
bool	RenameItem ( const FContentBrowserItemData& InI..., const FString& InNewName, FContentBrowserItemData& OutNewIte... )	Attempt to rename the given item.
bool	SaveItem ( const FContentBrowserItemData& InI..., const EContentBrowserItemSaveFlags ... )	Attempt to save the given item.
void	SetDataSink ( IContentBrowserItemDataSink* I... )	Set the data sink that can be used to communicate with the Content Browser Data Subsystem.
void	Shutdown()	Shutdown this data source instance.
void	Tick ( const float InDeltaTime )	Tick this data source instance.
bool	TryConvertInternalPathToVirtual ( const FName InInternalPath, FName& OutPath )	Convert an internal path to its virtualized form, based on the mount root set on this data source.
bool	TryConvertVirtualPathToInternal ( const FName InPath, FName& OutInternalPath )	Convert a virtualized path to its internal form, based on the mount root set on this data source.
bool	TryGetCollectionId ( const FContentBrowserItemData& InI..., FName& OutCollectionId )	Attempt to retrieve the identifier that should be used when storing a reference to the given item within a collection.
void	UnregisterDataSource()	Unregister this data source instance from the Content Browser Data Subsystem.
bool	UpdateThumbnail ( const FContentBrowserItemData& InI..., FAssetThumbnail& InThumbnail )	Attempt to update the thumbnail associated with the given item.

Overridden from UObject

		Name	Description
	void	BeginDestroy()	Called before destroying the object.

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

Take our survey

Dismiss