UContentBrowserDataSubsystem

Subsystem that provides access to Content Browser data.

Unreal Engine C++ API Reference > Editor > ContentBrowserData

Inheritance Hierarchy

References

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

Syntax

class UContentBrowserDataSubsystem :  
    public [UEditorSubsystem](API\Editor\EditorSubsystem\UEditorSubsystem),  
    public [IContentBrowserItemDataSink](API\Editor\ContentBrowserData\IContentBrowserItemDataSink)  

Remarks

Subsystem that provides access to Content Browser data. This type deals with the composition of multiple data sources, which provide information about the folders and files available in the Content Browser.

Constructors

Type Name Description
  UContentBrowserDataSubsystem ()  

Functions

Type Name Description
void ActivateAllDataSources () Activate all available data sources.
bool ActivateDataSource ( const FName Name ) Attempt to activate the named data source.
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.
void CompileFilter ( const FName InPath, const FContentBrowserDataFilter& I..., FContentBrowserDataCompiledFilter&... ) Take a raw data filter and convert it into a compiled version that could be re-used for multiple queries using the same data (typically this is only useful for post-filtering multiple items).
TArray< FStr... ConvertInternalPathsToVirtual ( const TArray< FString >& InPaths )  
void ConvertInternalPathToVirtual ( const FStringView InPath, FName& OutPath ) Converts an internal path to a virtual path based on current rules
void ConvertInternalPathToVirtual ( FName InPath, FName& OutPath ) Converts an internal path to a virtual path.
FName ConvertInternalPathToVirtual ( FName InPath ) Converts an internal path to a virtual path.
FContentBrow... CreateFolder ( const FName InPath ) Attempt to begin the process of asynchronously creating a folder at the given virtual path, returning a temporary item that can be finalized or canceled by the user.
void DeactivateAllDataSources () Deactivate all active data sources.
bool DeactivateDataSource ( const FName Name ) Attempt to deactivate the named data source.
void EnumerateItemsAtPath ( const FName InPath, const EContentBrowserItemTypeFilter..., TFunctionRef< bool(FContentBrowserI... ) Enumerate the items (folders and/or files) that exist at the given virtual path.
void EnumerateItemsAtPath ( const FName InPath, const EContentBrowserItemTypeFilter..., TFunctionRef< bool(FContentBrowserI... ) Enumerate the items (folders and/or files) that exist at the given virtual path.
bool EnumerateItemsAtPaths ( const TArrayView< struct FContentBr..., const EContentBrowserItemTypeFilter..., TFunctionRef< bool(FContentBrowserI... ) Enumerate the items (files) that exist at the given paths.
bool EnumerateItemsForObjects ( const TArrayView< UObject* > I..., TFunctionRef< bool(FContentBrowserI... ) Enumerate the items (files) that exist for the given objects.
void EnumerateItemsMatchingFilter ( const FContentBrowserDataCompiledFi..., TFunctionRef< bool(FContentBrowserI... ) Enumerate the items (folders and/or files) that match a previously compiled filter.
void EnumerateItemsMatchingFilter ( const FContentBrowserDataCompiledFi..., TFunctionRef< bool(FContentBrowserI... ) Enumerate the items (folders and/or files) that match a previously compiled filter.
void EnumerateItemsUnderPath ( const FName InPath, const FContentBrowserDataFilter& I..., TFunctionRef< bool(FContentBrowserI... ) Enumerate the items (folders and/or files) that exist under the given virtual path.
void EnumerateItemsUnderPath ( const FName InPath, const FContentBrowserDataFilter& I..., TFunctionRef< bool(FContentBrowserI... ) Enumerate the items (folders and/or files) that exist under the given virtual path.
TArray< FNam... GetActiveDataSources () Get the list of current active data sources.
TArray< FCon... GetAliasesForPath ( const FName InInternalPath ) Get a list of other paths that the data source may be using to represent a specific path
TArray< FCon... GetAliasesForPath ( const FContentBrowserItemPath InPat... ) Get a list of other paths that the data source may be using to represent a specific path
TArray< FCon... GetAliasesForPath ( const FSoftObjectPath& InInternalP... ) Get a list of other paths that the data source may be using to represent a specific path
const FStrin... GetAllFolderPrefix () Prefix to use when generating virtual paths and "Show All Folder" option is enabled
TArray< FNam... GetAvailableDataSources () Get the list of current available data sources.
const TArray... GetDefaultPathViewSpecialSortFolders () Returns reference to default list of paths that appear first in content browser based on internal or invariant paths
TSharedRef< ... GetEditableFolderPermissionList () Permission list that controls whether content in a given folder path can be edited.
FContentBrow... GetItemAtPath ( const FName InPath, const EContentBrowserItemTypeFilter... ) Get the first item (folder and/or file) that exists at the given virtual path.
TArray< FCon... GetItemsAtPath ( const FName InPath, const EContentBrowserItemTypeFilter... ) Get the items (folders and/or files) that exist at the given virtual path.
TArray< FCon... GetItemsUnderPath ( const FName InPath, const FContentBrowserDataFilter& I... ) Get the items (folders and/or files) that exist under the given virtual path.
const TArray... GetPathViewSpecialSortFolders () Returns reference to list of paths that appear first in content browser based on internal or invariant paths
bool IsDiscoveringItems ( TArray< FText >* OutStatus ) Query whether any data sources are currently discovering content, and retrieve optional status messages that can be shown in the UI.
bool IsFolderVisible ( const FName InPath, const EContentBrowserIsFolderVisibl... ) Query whether the given virtual folder should be visible in the UI.
void Legacy_TryConvertAssetDataToVirtualPaths ( const FAssetData& InAssetData, const bool InUseFolderPaths, TFunctionRef< bool(FName)> InCallba... ) Attempt to convert the given asset data to a virtual paths associated with the active data sources (callback will be called for each successful conversion).
void Legacy_TryConvertPackagePathToVirtualPaths ( const FName InPackagePath, TFunctionRef< bool(FName)> InCallba... ) Attempt to convert the given package path to virtual paths associated with the active data sources (callback will be called for each successful conversion).
FContentBrow... OnGenerateVirtualPathPrefix () Delegate called to generate a virtual path. Can be set to override default behavior.
FOnContentBr... OnItemDataDiscoveryComplete () Delegate called when all active data sources have completed their initial content discovery scan.
FOnContentBr... OnItemDataRefreshed () Delegate called for wholesale item data updates from data sources that can't provide delta-updates, or when the set of active data sources is modified.
FOnContentBr... OnItemDataUpdated () Delegate called for incremental item data updates from data sources that can provide delta-updates.
bool PrioritizeSearchPath ( const FName InPath ) If possible, attempt to prioritize content discovery for the given virtual path.
void RefreshVirtualPathTreeIfNeeded () Rebuild the virtual path tree if rules have changed.
void SetGenerateVirtualPathPrefixDelegate ( const FContentBrowserGenerateVirtua... ) Set delegate used to generate a virtual path.
void SetPathViewSpecialSortFolders ( const TArray< FName >& InSpecialSo... ) Customize list of folders that appear first in content browser based on internal or invariant paths
void SetVirtualPathTreeNeedsRebuild () Call when rules of virtual path generation have changed beyond content browser settings.
EContentBrow... TryConvertVirtualPath ( const FStringView InPath, FName& OutPath ) Converts virtual path back into an internal or invariant path
EContentBrow... TryConvertVirtualPath ( const FStringView InPath, FStringBuilderBase& OutPath ) Converts virtual path back into an internal or invariant path
EContentBrow... TryConvertVirtualPath ( const FStringView InPath, FString& OutPath ) Converts virtual path back into an internal or invariant path
EContentBrow... TryConvertVirtualPath ( const FName InPath, FName& OutPath ) Converts virtual path back into an internal or invariant path
TArray< FStr... TryConvertVirtualPathsToInternal ( const TArray< FString >& InVirtual... ) Returns array of paths converted to internal.

Overridden from USubsystem

Type Name Description
void Deinitialize () Implement this for deinitialization of instances of the system
void Initialize ( FSubsystemCollectionBase& Collecti... ) Implement this for initialization of instances of the system

Overridden from IContentBrowserItemDataSink

Type Name Description
void ConvertInternalPathToVirtual ( const FStringView InPath, FStringBuilderBase& OutPath ) Converts an internal path to a virtual path.

Classes

Type Name Description
Public struct FContentBrowserFilterCacheApi Provide an partial access to private api for the filter cache ID owners See FContentBrowserDataFilterCacheIDOwner declaration for how to use the caching for filter compilation

Typedefs

Name Description
FNameToDataSourceMap  

Deprecated Functions

Type Name Description
bool IsFolderVisibleIfHidingEmpty ( const FName InPath ) IsFolderVisibleIfHidingEmpty is deprecated. Use IsFolderVisible instead and add EContentBrowserIsFolderVisibleFlags::HideEmptyFolders to the flags.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library