ContentBrowser

API > API/Editor

   
Name ContentBrowser
Type Editor
Location /Engine/Source/Editor/ContentBrowser/
Module Build Rules ContentBrowser.Build.cs

Classes

Name Remarks
FAssetTextFilter Class handling text filtering for content browser views.
FAssetViewExtraStateGenerator Extra state generator that adds an icon and a corresponding legend entry on an asset.
FAssetViewSortManager  
FCompiledAssetTextFilter Context object for parallel filtering Allows reuse of memory when filtering in ParallelForWithTaskContext
FContentBrowserModule Content browser module
FContentBrowserPluginFilter  
FContentBrowserPluginFilter_ContentOnlyPlugins  
FFrontendFilter  
FFrontendFilter_ArbitraryComparisonOperation A filter that compares the value of an asset registry tag to a target value
FFrontendFilter_CheckedOut A filter that displays only checked out assets
FFrontendFilter_Favorites A filter that displays only assets the are mark as Favorite
FFrontendFilter_InUseByLoadedLevels An inverse filter that allows display of content in developer folders that are not the current user's An inverse filter that allows display of object redirectors A filter that only displays assets used by loaded levels
FFrontendFilter_Modified A filter that displays only modified assets
FFrontendFilter_NotSourceControlled A filter that displays assets not tracked by source control
FFrontendFilter_NotUsedInAnyAsset A filter that only displays assets not used in another asset (Note It does not update itself automatically)
FFrontendFilter_NotUsedInAnyLevel A filter that only displays assets not used by any level
FFrontendFilter_Recent A filter that displays recently opened assets
FFrontendFilter_ReplicatedBlueprint A filter that displays blueprints that have replicated properties
FFrontendFilter_Text A filter for text search
FFrontendFilter_Unsupported A filter that displays only assets the are mark as unsupported
FFrontendFilter_UsedInAnyLevel A filter that only displays assets used by any level
FFrontendFilter_VirtualizedData A filter that displays only packages that contain virtualized data
FFrontendFilter_Writable A filter that displays only assets that are not read only
FFrontendFilterCategory  
FHistoryManager The class responsible for managing all content browser history
SAssetColumnItem An item in the asset column view
SAssetColumnView The columns view mode of the asset view
SAssetColumnViewRow  
SAssetListItem An item in the asset list view
SAssetListView The list view mode of the asset view
SAssetListViewRow  
SAssetMenuIcon Represents an Asset Type within a menu.
SAssetTileItem An item in the asset tile view
SAssetTileView The tile view mode of the asset view
SAssetView A widget to display a list of filtered assets
SAssetViewItem A base class for all asset view items
SListView  
UContentBrowserAddNewContextMenuContext  
UContentBrowserAssetContextMenuContext  
UContentBrowserAssetSortingContextMenuContext  
UContentBrowserAssetViewContextMenuContext  
UContentBrowserFolderContext  
UContentBrowserFrontEndFilterExtension Override this class in order to make an additional front-end filter available in the Content Browser.
UContentBrowserMenuContext  
UContentBrowserToolbarMenuContext  

Structs

Name Remarks
FAssetAddedToCollectionTelemetryEvent Workflow event when assets are added to a collection.
FAssetPickerConfig A struct containing details about how the asset picker should behave
FAssetRemovedFromCollectionTelemetryEvent Workflow event when assets are removed from a collection.
FAssetViewContentSources  
FAssetViewCustomColumn Struct to define a custom column for the asset view
FAssetViewDragAndDropExtender Contains the delegates used to handle a custom drag-and-drop in the asset view
FAssetViewItemHelper  
FBackendFilterTelemetry  
FCollectionCreatedTelemetryEvent Workflow event when a collection is created.
FCollectionPickerConfig A struct containing details about how the collection picker should behave
FCollectionsDeletedTelemetryEvent Workflow event when a set of collections are deleted.
FContentBrowserConfig A struct containing details about how the content browser should behave
FContentBrowserSelection A selection of items in the Content Browser
FContentSourceColumn Column added to a widget row that contains a pointer to the content source the widget belongs to
FFrontendFilterTelemetry  
FHistoryData The history data object, storing all important history data
FOpenAssetDialogConfig A struct containing details about how the open asset dialog should behave.
FPathPickerConfig A struct containing details about how the path picker should behave
FSaveAssetDialogConfig A struct containing details about how the save asset dialog should behave.
FSelectionData  
FSharedAssetDialogConfig A struct containing shared details about how asset dialogs should behave.
FSourcesData  
FTableViewerInitParams Init Params used by the STedsTableViewer displayed in place of the legacy Content Browser when this content source is active

Interfaces

Name Remarks
IAssetSearchOverride Interface for an asset search override that can hook into the Content Browser's filter and sort pipeline.
IAssetTextFilterHandler Interface that can be implemented to extend text filtering in the content browser.
ICBSearchOverrideInstance Interface to contains the state per view of the search override
IContentBrowserSingleton Content browser module singleton
IContentBrowserViewExtender Interface that can be used to add a custom view to the Content Browser NOTE: This API is likely to change as it is being actively iterated on
IContentSource A Content Source is a construct that can customize the look and behavior of the content browser through TEDS (Editor Data Storage) intended to replace the legacy asset specific content browser.

Typedefs

Name Type Remarks Include Path
FAssetFilterCollectionType TFilterCollection< FAssetFilterType >   IContentBrowserSingleton.h
FAssetFilterType const FContentBrowserItem &   IContentBrowserSingleton.h
FClearSelectionDelegate TBaseDelegate_NoParams< void > Called to clear the selection of the specified assetdata or all selection if an invalid assetdata is passed ContentBrowserDelegates.h
FConstructToolTipForAsset TBaseDelegate_OneParam< TSharedRef< SToolTip >, const FAssetData & > Called to retrieve the tooltip for the specified asset ContentBrowserDelegates.h
FContentBrowserCommandExtender TBaseDelegate_TwoParams< void, TSharedRef< FUICommandList >, FOnContentBrowserGetSelection >   ContentBrowserDelegates.h
FContentBrowserMenuExtender TBaseDelegate_NoParams< TSharedRef< FExtender > > Called to request the menu when right clicking on a path ContentBrowserDelegates.h
FContentBrowserMenuExtender_SelectedAssets TBaseDelegate_OneParam< TSharedRef< FExtender >, const TArray< FAssetData > & >   ContentBrowserDelegates.h
FContentBrowserMenuExtender_SelectedPaths TBaseDelegate_OneParam< TSharedRef< FExtender >, const TArray< FString > & >   ContentBrowserDelegates.h
FGetCurrentSelectionDelegate TBaseDelegate_NoParams< TArray< FAssetData > > Called to retrieve an array of the currently selected asset data ContentBrowserDelegates.h
FIsFolderShowPrivateContentToggleableDelegate TBaseDelegate_OneParam< bool, const FStringView > Called when custom behavior is needed for allowing folders to toggle their private content edit state ContentBrowserDelegates.h
FLoadAssetViewSettingsDelegate TBaseDelegate_NoParams< void > Called to load/restore the asset view settings ContentBrowserDelegates.h
FOnApplyHistoryData TBaseDelegate_OneParam< void, const FHistoryData & > The delegate for when history data should be applied HistoryManager.h
FOnAssetDialogCancelled TBaseDelegate_NoParams< void > Called from the Asset Dialog when a non-modal dialog is closed or cancelled ContentBrowserDelegates.h
FOnAssetDoubleClicked TBaseDelegate_OneParam< void, const FAssetData & > Called when an asset is double clicked in the asset view ContentBrowserDelegates.h
FOnAssetEnterPressed TBaseDelegate_OneParam< void, const TArray< FAssetData > & > Called when enter is pressed on an asset in the asset view ContentBrowserDelegates.h
FOnAssetsActivated TBaseDelegate_TwoParams< void, const TArray< FAssetData > &, EAssetTypeActivationMethod::Type > Called when the user double clicks, presses enter, or presses space on an asset ContentBrowserDelegates.h
FOnAssetsChosenForOpen TBaseDelegate_OneParam< void, const TArray< FAssetData > & > Called from the Asset Dialog when assets are chosen in non-modal Open dialogs ContentBrowserDelegates.h
FOnAssetsDragged TBaseDelegate_OneParam< void, const TArray< FAssetData > & > Called when asset(s) are dragged in the asset view ContentBrowserDelegates.h
FOnAssetSelected TBaseDelegate_OneParam< void, const FAssetData & > Called when an asset is selected in the asset view ContentBrowserDelegates.h
FOnAssetToolTipClosing TBaseDelegate_NoParams< void > Called when an asset item's tooltip is closing ContentBrowserDelegates.h
FOnAssetViewNewItemRequested TBaseDelegate_OneParam< void, const FContentBrowserItem & > Fires whenever the asset view is asked to start to create a temporary item SAssetView.h
FOnCollectionSelected TBaseDelegate_OneParam< void, const FCollectionNameType & > Called when a collection is selected in the collections view ContentBrowserDelegates.h
FOnColumnVisibilityChanged TBaseDelegate_OneParam< void, const TArray< FString > & > Called when the user changes which columns are hidden in the asset column/list view ContentBrowserDelegates.h
FOnContentBrowserCanShowSetAssetAccessMenu TBaseDelegate_TwoParams< bool, const FStringView, const FAssetData & > Called to check if should show menu entries to set asset public/private ContentBrowserDelegates.h
FOnContentBrowserGetSelection TBaseDelegate_TwoParams< void, TArray< FAssetData > &, TArray< FString > & > Called when registering a custom command/keybinding for the content browser ContentBrowserDelegates.h
FOnContentBrowserItemRenameCommitted TBaseDelegate_OneParam< void, TArrayView< const FContentBrowserItem > > Called when the user has committed a rename of one or more items ContentBrowserDelegates.h
FOnContentBrowserItemsActivated TBaseDelegate_TwoParams< void, TArrayView< const FContentBrowserItem >, EAssetTypeActivationMethod::Type > Called when the user double clicks, presses enter, or presses space on a Content Browser item ContentBrowserDelegates.h
FOnContentBrowserItemsDragged TBaseDelegate_OneParam< void, TArrayView< const FContentBrowserItem > > Called when the user drags one or more Content Browser items ContentBrowserDelegates.h
FOnContentBrowserItemSelectionChanged TBaseDelegate_TwoParams< void, const FContentBrowserItem &, ESelectInfo::Type > Delegate called when item selection is changed ContentBrowserDelegates.h
FOnCreateNewFolder TBaseDelegate_OneParam< void, const FContentBrowserItemTemporaryContext & > Called when a new folder is starting to be created ContentBrowserDelegates.h
FOnDeleteFolders TMulticastDelegate_OneParam< void, const TArray< FContentBrowserItemPath > & > Called when one or more folders are being deleted ContentBrowserDelegates.h
FOnExtendAssetViewOptionsMenuContext TBaseDelegate_OneParam< void, FToolMenuContext & > Fires whenever asset view options menu is being opened, gives chance for external code to set additional context SAssetView.h
FOnFavoritesChanged TMulticastDelegate_TwoParams< void, const FContentBrowserItemPath &, bool > Called when an item is added or removed from favorites ContentBrowserDelegates.h
FOnGenerateAssetViewExtraStateIndicators TBaseDelegate_OneParam< TSharedRef< SWidget >, const FAssetData & > Called to generate extra state information icons or tooltips on asset items. ContentBrowserDelegates.h
FOnGetAssetContextMenu TBaseDelegate_OneParam< TSharedPtr< SWidget >, const TArray< FAssetData > & > Called to request the menu when right clicking on an asset ContentBrowserDelegates.h
FOnGetContentBrowserItemContextMenu TBaseDelegate_OneParam< TSharedPtr< SWidget >, TArrayView< const FContentBrowserItem > > Called to request the menu when right clicking on an selection of items (maybe be a mix of folders and files) ContentBrowserDelegates.h
FOnGetCustomAssetColumnData TBaseDelegate_TwoParams< FString, FAssetData &, FName > Called to get string/text value for a custom column, will get converted as necessary ContentBrowserDelegates.h
FOnGetCustomAssetColumnDisplayText TBaseDelegate_TwoParams< FText, FAssetData &, FName >   ContentBrowserDelegates.h
FOnGetCustomAssetToolTip TBaseDelegate_OneParam< TSharedRef< SToolTip >, FAssetData & > Called to request a custom asset item tooltip ContentBrowserDelegates.h
FOnGetFolderContextMenu TBaseDelegate_ThreeParams< TSharedPtr< SWidget >, const TArray< FString > &, FContentBrowserMenuExtender_SelectedPaths, FOnCreateNewFolder > Called to request the menu when right clicking on an asset ContentBrowserDelegates.h
FOnIsAssetValidForCustomToolTip TBaseDelegate_OneParam< bool, FAssetData & > Called to see if it is valid to request a custom asset item tooltip ContentBrowserDelegates.h
FOnItemDestroyed TBaseDelegate_OneParam< void, const TSharedPtr< FAssetViewItem > & >   AssetViewWidgets.h
FOnObjectPathChosenForSave TBaseDelegate_OneParam< void, const FString & > Called from the Asset Dialog when an asset name is chosen in non-modal Save dialogs ContentBrowserDelegates.h
FOnPathSelected TBaseDelegate_OneParam< void, const FString & > Called when a path is selected in the path picker ContentBrowserDelegates.h
FOnRenameBegin TBaseDelegate_ThreeParams< void, const TSharedPtr< FAssetViewItem > &, const FString &, const FSlateRect & >   AssetViewWidgets.h
FOnRenameCommit TBaseDelegate_FourParams< void, const TSharedPtr< FAssetViewItem > &, const FString &, const FSlateRect &, ETextCommit::Type >   AssetViewWidgets.h
FOnSearchOptionChanged TBaseDelegate_NoParams< void > Fires whenever one of the "Search" options changes, useful for modifying search criteria to match SAssetView.h
FOnSearchTextChanged TBaseDelegate_OneParam< void, const FText & > Fired when the search box text changes. ContentBrowserDelegates.h
FOnSetFolderColor TMulticastDelegate_OneParam< void, const FString & > Called when a custom folder color is set on a folder ContentBrowserDelegates.h
FOnShouldDisplayAssetTag TBaseDelegate_TwoParams< bool, FName, FName > Called to check if an asset tag should be display in details view. ContentBrowserDelegates.h
FOnShouldFilterAsset TBaseDelegate_OneParam< bool, const FAssetData & > Called to check if an asset should be filtered out by external code. ContentBrowserDelegates.h
FOnShouldFilterItem TBaseDelegate_OneParam< bool, const FContentBrowserItem & > Called to check if an item should be filtered out by external code. ContentBrowserDelegates.h
FOnThumbnailScaleChanged TBaseDelegate_OneParam< void, const float > Called when thumbnail scale changes and the thumbnail scale is bound to a delegate ContentBrowserDelegates.h
FOnUpdateHistoryData TBaseDelegate_OneParam< void, FHistoryData & > The delegate for when history data should be updated HistoryManager.h
FOnVerifyRenameCommit TBaseDelegate_FourParams< bool, const TSharedPtr< FAssetViewItem > &, const FText &, const FSlateRect &, FText & >   AssetViewWidgets.h
FOnVisualizeAssetToolTip TBaseDelegate_TwoParams< bool, const TSharedPtr< SWidget > &, FAssetData & > Called when an asset item visualizes its tooltip ContentBrowserDelegates.h
FPathViewStateIconGenerator TBaseDelegate_OneParam< TSharedPtr< SWidget >, const FContentBrowserItem & > Called to generate state information icons for path view items. ContentBrowserDelegates.h
FPluginFilterCollectionType TFilterCollection< FPluginFilterType >   IContentBrowserSingleton.h
FPluginFilterType const TSharedRef< IPlugin > &   IContentBrowserSingleton.h
FRefreshAssetViewDelegate TBaseDelegate_OneParam< void, bool > Called to force the asset view to refresh ContentBrowserDelegates.h
FSaveAssetViewSettingsDelegate TBaseDelegate_NoParams< void > Called to save the asset view settings (column widths, sort order, hidden columns, etc.) ContentBrowserDelegates.h
FSetARFilterDelegate TBaseDelegate_OneParam< void, const FARFilter & > Called to set a new filter for an existing asset picker ContentBrowserDelegates.h
FSetPathPickerPathsDelegate TBaseDelegate_OneParam< void, const TArray< FString > & > A pointer to an existing delegate that, when executed, will set the filter an the asset picker after it is created. ContentBrowserDelegates.h
FSyncToAssetsDelegate TBaseDelegate_OneParam< void, const TArray< FAssetData > & > Called to retrieve an array of the currently selected asset data ContentBrowserDelegates.h

Enums

Public

Name Remarks
EAssetDialogType::Type  
EAssetViewCopyType Copy types
EAssetViewType::Type The view modes used in SAssetView
ECollectionTelemetryAssetAddedWorkflow  
ECollectionTelemetryAssetRemovedWorkflow  
EFolderType  
EIncludeSubclasses  
ESaveAssetDialogExistingAssetPolicy::Type An enum to choose the behavior of the save asset dialog when the user chooses an asset that already exists

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIsFavorite bool   Experimental/ContentBrowserExtensionUtils.h  
bool const FContentBrowserItemData const   ContentBrowserDelegates.h  
FGetItemDataAttribute const FContentBrowserItemData const const FContentBrowserItemDataAttributeValue &   ContentBrowserDelegates.h  
FName const FContentBrowserItemData const const   ContentBrowserDelegates.h  
FolderColor const FLinearColor &   Experimental/ContentBrowserExtensionUtils.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TArray< FName > ContentBrowserInstanceUtils::GetConfigNames()

 Gets a list of names for all existing content browser configs ContentBrowserInstanceUtils.h  

bool ContentBrowserInstanceUtils::GetFavoritesExpanded ( const FName& InstanceName
)

 Gets whether we are allowed to expand favorites ContentBrowserInstanceUtils.h  

bool ContentBrowserInstanceUtils::GetFilterRecursively ( const FName& InstanceName
)

 Gets whether we are allowed to filter recursively when a filter is applied ContentBrowserInstanceUtils.h  

bool ContentBrowserInstanceUtils::GetSearchAssetPaths ( const FName& InstanceName
)

 Gets whether we are allowed to search asset paths (instead of asset name only) ContentBrowserInstanceUtils.h  

bool ContentBrowserInstanceUtils::GetSearchClasses ( const FName& InstanceName
)

 Gets whether we are allowed to search in asset class names ContentBrowserInstanceUtils.h  

bool ContentBrowserInstanceUtils::GetSearchCollections ( const FName& InstanceName
)

 Gets whether we are allowed to search for collection names ContentBrowserInstanceUtils.h  

bool ContentBrowserInstanceUtils::GetShowCppFolders ( const FName& InstanceName
)

 Gets whether we are allowed to display cpp folders ContentBrowserInstanceUtils.h  

bool ContentBrowserInstanceUtils::GetShowDeveloperContent ( const FName& InstanceName
)

 Gets whether we are allowed to display developer content ContentBrowserInstanceUtils.h  

bool ContentBrowserInstanceUtils::GetShowEmptyFolders ( const FName& InstanceName
)

 Gets whether we are allowed to display empty folders ContentBrowserInstanceUtils.h  

bool ContentBrowserInstanceUtils::GetShowEngineContent ( const FName& InstanceName
)

 Gets whether we are allowed to display engine content ContentBrowserInstanceUtils.h  

bool ContentBrowserInstanceUtils::GetShowFavorites ( const FName& InstanceName
)

 Gets whether we are allowed to display favorites ContentBrowserInstanceUtils.h  

bool ContentBrowserInstanceUtils::GetShowFolders ( const FName& InstanceName
)

 Gets whether we are allowed to display folders ContentBrowserInstanceUtils.h  

bool ContentBrowserInstanceUtils::GetShowLocalizedContent ( const FName& InstanceName
)

 Gets whether we are allowed to display localized content ContentBrowserInstanceUtils.h  

bool ContentBrowserInstanceUtils::GetShowPluginContent ( const FName& InstanceName
)

 Gets whether we are allowed to display plugin content ContentBrowserInstanceUtils.h  

bool ContentBrowserInstanceUtils::GetSourcesExpanded ( const FName& InstanceName
)

 Gets whether we are allowed to expand sources ContentBrowserInstanceUtils.h  

void ContentBrowserInstanceUtils::SaveAllConfigs()

 Saves all content browser configs ContentBrowserInstanceUtils.h  

void ContentBrowserInstanceUtils::SetFavoritesExpanded ( const FName& InstanceName,
const bool bInFavoritesExpanded,
const bool bInSaveConfig
)

 Sets whether we are allowed to expand favorites ContentBrowserInstanceUtils.h  

void ContentBrowserInstanceUtils::SetFilterRecursively ( const FName& InstanceName,
const bool bInFilterRecursively,
const bool bInSaveConfig
)

 Sets whether we are allowed to filter recursively when a filter is applied ContentBrowserInstanceUtils.h  

void ContentBrowserInstanceUtils::SetSearchAssetPaths ( const FName& InstanceName,
const bool bInSearchAssetPaths,
const bool bInSaveConfig
)

 Sets whether we are allowed to search asset paths (instead of asset name only) ContentBrowserInstanceUtils.h  

void ContentBrowserInstanceUtils::SetSearchClasses ( const FName& InstanceName,
const bool bInSearchClasses,
const bool bInSaveConfig
)

 Sets whether we are allowed to search in asset class names ContentBrowserInstanceUtils.h  

void ContentBrowserInstanceUtils::SetSearchCollections ( const FName& InstanceName,
const bool bInSearchCollections,
const bool bInSaveConfig
)

 Sets whether we are allowed to search for collection names ContentBrowserInstanceUtils.h  

void ContentBrowserInstanceUtils::SetShowCppFolders ( const FName& InstanceName,
const bool bInShowCppFolders,
const bool bInSaveConfig
)

 Sets whether we are allowed to display cpp folders ContentBrowserInstanceUtils.h  

void ContentBrowserInstanceUtils::SetShowDeveloperContent ( const FName& InstanceName,
const bool bInShowDeveloperContent,
const bool bInSaveConfig
)

 Sets whether we are allowed to display developer content ContentBrowserInstanceUtils.h  

void ContentBrowserInstanceUtils::SetShowEmptyFolders ( const FName& InstanceName,
const bool bInShowEmptyFolders,
const bool bInSaveConfig
)

 Sets whether we are allowed to display empty folders ContentBrowserInstanceUtils.h  

void ContentBrowserInstanceUtils::SetShowEngineContent ( const FName& InstanceName,
const bool bInShowEngineContent,
const bool bInSaveConfig
)

 Sets whether we are allowed to display engine content ContentBrowserInstanceUtils.h  

void ContentBrowserInstanceUtils::SetShowFavorites ( const FName& InstanceName,
const bool bInShowFavorites,
const bool bInSaveConfig
)

 Sets whether we are allowed to display favorites ContentBrowserInstanceUtils.h  

void ContentBrowserInstanceUtils::SetShowFolders ( const FName& InstanceName,
const bool bInShowFolders,
const bool bInSaveConfig
)

 Sets whether we are allowed to display folders ContentBrowserInstanceUtils.h  

void ContentBrowserInstanceUtils::SetShowLocalizedContent ( const FName& InstanceName,
const bool bInShowLocalizedContent,
const bool bInSaveConfig
)

 Sets whether we are allowed to display localized content ContentBrowserInstanceUtils.h  

void ContentBrowserInstanceUtils::SetShowPluginContent ( const FName& InstanceName,
const bool bInShowPluginContent,
const bool bInSaveConfig
)

 Sets whether we are allowed to display plugin content ContentBrowserInstanceUtils.h  

void ContentBrowserInstanceUtils::SetSourcesExpanded ( const FName& InstanceName,
const bool bInSourcesExpanded,
const bool bInSaveConfig
)

 Sets whether we are allowed to expand sources ContentBrowserInstanceUtils.h  

ENUM_CLASS_FLAGS ( EFolderType
)

 An item (folder or file) displayed in the asset view AssetViewTypes.h  

UE::Editor::ContentBrowser::ExtensionUtils::UE_EXPERIMENTAL (

  1. 8,
    "The Content Browser extension utils are experimental hooks that may be removed in the future"
    ) const
 Get the custom color of the given folder (if any). Prefer using this over raw FName variants. Experimental/ContentBrowserExtensionUtils.h  

UE_EXPERIMENTAL (

  1. 7,
    "FGetItemDataAttribute is experimental while a newer system is in active development."
    )
 Called to get ContentBrowserItemData attribute values. ContentBrowserDelegates.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page