1. Epic GamesDeveloper
  3. IContentBrowserSingleton

IContentBrowserSingleton

Content browser module singleton

API > API/Editor > API/Editor/ContentBrowser

Content browser module singleton

   
Name IContentBrowserSingleton
Type class
Header File /Engine/Source/Editor/ContentBrowser/Public/IContentBrowserSingleton.h
Include Path #include "IContentBrowserSingleton.h"

Syntax

class IContentBrowserSingleton

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IContentBrowserSingleton()

 Virtual destructor IContentBrowserSingleton.h  

Typedefs

Name Type Remarks Include Path
FContentSourceFactory TBaseDelegate_NoParams< TSharedRef< UE::Editor::ContentBrowser::IContentSource > > Factory delegate that instantiates a content source IContentBrowserSingleton.h
FOnContentSourceFactoriesChanged TMulticastDelegate_NoParams< void > Delegate fired when a new content source factory is registered/unregistered IContentBrowserSingleton.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddCustomTextFilter ( const FCustomTextFilterData& FilterData,
bool bApplyFilter
)

 Adds a Custom Text Filter to the Filter List IContentBrowserSingleton.h  

void CaptureThumbnailFromViewport ( FViewport* InViewport,
TArray< FAssetData >& SelectedAssets
)

 Capture active viewport to thumbnail and assigns that thumbnail to incoming assets IContentBrowserSingleton.h  

TSharedRef< SWidget > CreateAssetPicker ( const FAssetPickerConfig& AssetPickerConfig
)

 Generates an asset picker widget locked to the specified FARFilter. IContentBrowserSingleton.h  

TSharedRef< SWidget > CreateCollectionPicker ( const FCollectionPickerConfig& CollectionPickerConfig
)

 Generates a collection picker widget. IContentBrowserSingleton.h  

TSharedRef< SWidget > CreateContentBrowser ( const FName InstanceName,
TSharedPtr< SDockTab > ContainingTab,
const FContentBrowserConfig* ContentBrowserConfig
)

 Generates a content browser. IContentBrowserSingleton.h  

TSharedRef< SWidget > CreateContentBrowserDrawer ( const FContentBrowserConfig& ContentBrowserConfig,
TFunction< TSharedPtr< SDockTab >()> InOnGetTabForDrawer
)

 Generates a content browser for use in a drawer. IContentBrowserSingleton.h  

TArray< FAssetData > CreateModalOpenAssetDialog ( const FOpenAssetDialogConfig& InConfig
)

 Opens the Open Asset dialog in a modal window IContentBrowserSingleton.h  

FString CreateModalSaveAssetDialog ( const FSaveAssetDialogConfig& SaveAssetConfig
)

 Opens the Save Asset dialog in a modal window IContentBrowserSingleton.h  

void CreateNewAsset ( const FString& DefaultAssetName,
const FString& PackagePath,
UClass* AssetClass,
UFactory* Factory
)

 Sets up an inline-name for the creation of a new asset in the primary content browser using the specified path and the specified class and/or factory IContentBrowserSingleton.h  

void CreateOpenAssetDialog ( const FOpenAssetDialogConfig& OpenAssetConfig,
const FOnAssetsChosenForOpen& OnAssetsChosenForOpen,
const FOnAssetDialogCancelled& OnAssetDialogCancelled
)

 Opens the Open Asset dialog in a non-modal window IContentBrowserSingleton.h  

TSharedRef< SWidget > CreatePathPicker ( const FPathPickerConfig& PathPickerConfig
)

 Generates a path picker widget. IContentBrowserSingleton.h  

void CreateSaveAssetDialog ( const FSaveAssetDialogConfig& SaveAssetConfig,
const FOnObjectPathChosenForSave& OnAssetNameChosenForSave,
const FOnAssetDialogCancelled& OnAssetDialogCancelled
)

 Opens the Save Asset dialog in a non-modal window IContentBrowserSingleton.h  

void DeleteCustomTextFilterByLabel ( const FText& FilterLabel
)

 Deletes the specified Custom Text Filter IContentBrowserSingleton.h  

void DockContentBrowserDrawer()

 Docks the current content browser drawer as a tabbed content browser in a layout IContentBrowserSingleton.h  

void ExecuteAddFolder ( TSharedPtr< SWidget > PathPickerWidget
)

 Add a folder to the path picker widget under the current selected path. IContentBrowserSingleton.h  

void ExecuteRename ( TSharedPtr< SWidget > PickerWidget
)

 Rename current first selected content item on the passed in widget. IContentBrowserSingleton.h  

void FocusContentBrowserSearchField ( TSharedPtr< SWidget > ContentBrowserWidget
)

 Focuses the search field of a content browser widget IContentBrowserSingleton.h  

void FocusPrimaryContentBrowser ( bool bFocusSearch
)

 Brings the primary content browser to the front or opens one if it does not exist. IContentBrowserSingleton.h  

void ForceShowPluginContent ( bool bEnginePlugin
)

 Forces the content browser to show plugin content if it's not already showing. IContentBrowserSingleton.h  

void ForEachContentSourceFactory ( const TFunctionRef< void(const FName&, const FContentSourceFactory&)>& InFunction
)

 Execute a delegate for each registered content source factory IContentBrowserSingleton.h  

void ForEachFavoriteFolder ( TFunctionRef< void(const FContentBrowserItemPath&)> InDelegate
)

 Iterate through each favorite folder and call the delegate IContentBrowserSingleton.h  

TSharedPtr< SWidget > GetActiveFilterContainer()

 Gets a pointer to the active filter container widget (Horizontal or Vertical), nullptr if neither is active IContentBrowserSingleton.h  

TArray< FString > GetAliasesForPath ( const FSoftObjectPath& InPath
) const

 Get a list of other paths that the data source may be using to represent a specific path IContentBrowserSingleton.h  

TSharedPtr< SWidget > GetAssetPickerSearchBox ( const TSharedRef< SWidget >& AssetPickerWidget
)

 Focus the search box of the given asset picker widget. IContentBrowserSingleton.h  

FString GetCurrentPath ( const EContentBrowserPathType PathType
)

 Gets the current path if one exists, otherwise returns empty string. IContentBrowserSingleton.h  

FContentBrowserItemPath GetCurrentPath ()

 Gets the current path if one exists, otherwise returns empty string. IContentBrowserSingleton.h  

EFilterBarLayout GetFilterLayout()

 Gets the current Content Browser filter layout IContentBrowserSingleton.h  

FContentBrowserItemPath GetInitialPathToSaveAsset ( const FContentBrowserItemPath& InPath
)

 Returns InPath if can be written to, otherwise picks a default path that can be written to IContentBrowserSingleton.h  

void GetSelectedAssets ( TArray< FAssetData >& SelectedAssets
)

 Generates a list of assets that are selected in the primary content browser IContentBrowserSingleton.h  

void GetSelectedFolders ( TArray< FString >& SelectedFolders
)

 Generates a list of folders that are selected in the primary content browser IContentBrowserSingleton.h  

void GetSelectedPathViewFolders ( TArray< FString >& SelectedFolders
)

 Returns the folders that are selected in the path view IContentBrowserSingleton.h  

const TSharedPtr< FPathPermissionList > & GetShowEpicInternalContentPermissionList()

 Returns the Internal Content Permission List IContentBrowserSingleton.h  

const TSharedPtr< FPathPermissionList > & GetShowPrivateContentPermissionList()

 Returns the Private Content Permission List IContentBrowserSingleton.h  

bool HasPrimaryContentBrowser()

 Returns true if there is at least one browser open that is eligible to be a primary content browser IContentBrowserSingleton.h  

bool IsAssetViewDoneFiltering()

 Gets whether the AssetView in the Content Browser is done filtering IContentBrowserSingleton.h  

bool IsFolderShowPrivateContentToggleable ( const FStringView VirtualFolderPath
)

 Returns true if FolderPath's private content edit mode is allowed to be toggled IContentBrowserSingleton.h  

bool IsShowingPrivateContent ( const FStringView VirtualFolderPath
)

 Returns true if FolderPath is a private content edit folder IContentBrowserSingleton.h  

void ModifyCustomTextFilterByLabel ( const FCustomTextFilterData& FilterData,
const FText& FilterLabel
)

 Modifies the specified Custom Text Filter IContentBrowserSingleton.h  

FOnContentSourceFactoriesChanged & OnContentSourceFactoriesChanged()

   IContentBrowserSingleton.h  

void RefreshPathView ( TSharedPtr< SWidget > PathPickerWidget
)

 Force refresh on the path picker widget. IContentBrowserSingleton.h  

void RegisterContentSourceFactory ( const FName& InContentSourceName,
const FContentSourceFactory& InContentSourceFactory
)

 Register a content source by name, causing it to appear in the content sources bar as selectable (if the bar is enabled) IContentBrowserSingleton.h  

void RegisterIsFolderShowPrivateContentToggleableDelegate ( FIsFolderShowPrivateContentToggleableDelegate InIsFolderShowPrivateContentToggleableDelegate
)

 Registers the delegate for custom handling of if a Folder allows private content edits IContentBrowserSingleton.h  

FDelegateHandle RegisterOnFavoritesChangedHandler ( FOnFavoritesChanged::FDelegate InOnFavoritesChanged
)

 Register a delegate to be called when the Favorites changes. IContentBrowserSingleton.h  

FDelegateHandle RegisterOnFavoritesChangedHandler ( FSimpleDelegate OnFavoritesChanged
)

 Register a delegate to be called when the Favorites changes. IContentBrowserSingleton.h  

void SaveContentBrowserSettings ( TSharedPtr< SWidget > ContentBrowserWidget
)

 Saves the settings for a particular content browser instance IContentBrowserSingleton.h  

void SetFilterLayout ( EFilterBarLayout InFilterBarLayout
)

 Sets the Content Browser filter layout to either vertical or horizontal IContentBrowserSingleton.h  

bool SetPrimaryContentBrowser ( FName InstanceName
)

 Sets the primary content browser for subsequent state changes through this singleton Returns true if content browser was changed sucessfully IContentBrowserSingleton.h  

void SetPrivateContentPermissionListDirty()

 Declares the Private Content Permission List dirty IContentBrowserSingleton.h  

void SetSearchText ( const FText& NewText
)

 Sets the AssetSearchBox text IContentBrowserSingleton.h  

void SetSelectedPaths ( const TArray< FString >& FolderPaths,
bool bNeedsRefresh,
bool bPathsAreVirtual
)

 Sets the content browser to display the selected paths IContentBrowserSingleton.h  

void SyncBrowserTo ( const FContentBrowserSelection& ItemSelection,
bool bAllowLockedBrowsers,
bool bFocusContentBrowser,
const FName& InstanceName,
bool bNewSpawnBrowser
)

 Selects the supplied assets in the primary content browser. IContentBrowserSingleton.h  

void SyncBrowserToAssets ( const TArray< struct FAssetData >& AssetDataList,
bool bAllowLockedBrowsers,
bool bFocusContentBrowser,
const FName& InstanceName,
bool bNewSpawnBrowser
)

 Selects the supplied assets in the primary content browser. IContentBrowserSingleton.h  

void SyncBrowserToAssets ( const TArray< UObject* >& AssetList,
bool bAllowLockedBrowsers,
bool bFocusContentBrowser,
const FName& InstanceName,
bool bNewSpawnBrowser
)

 Selects the supplied assets in the primary content browser. IContentBrowserSingleton.h  

void SyncBrowserToFolders ( const TArray< FString >& FolderList,
bool bAllowLockedBrowsers,
bool bFocusContentBrowser,
const FName& InstanceName,
bool bNewSpawnBrowser
)

 Selects the supplied assets in the primary content browser. IContentBrowserSingleton.h  

void SyncBrowserToItems ( const TArray< FContentBrowserItem >& ItemsToSync,
bool bAllowLockedBrowsers,
bool bFocusContentBrowser,
const FName& InstanceName,
bool bNewSpawnBrowser
)

 Selects the supplied items in the primary content browser. IContentBrowserSingleton.h  

void ToggleFolderFavorite ( const TArray< FString >& FolderPaths
)

 Toggle the Favorite status of the given folder list IContentBrowserSingleton.h  

void UnregisterContentSourceFactory ( const FName& InContentSourceName
)

 Unregister a content source by name IContentBrowserSingleton.h  

void UnregisterIsFolderShowPrivateContentToggleableDelegate()

 Unregisters the delegate for custom handling of if a Folder allows private content edits IContentBrowserSingleton.h  

void UnregisterOnFavoritesChangedDelegate ( FDelegateHandle Handle
)

 Unregister a previously-registered handler for when Favorites changes. IContentBrowserSingleton.h  

Static

Name Remarks Include Path Unreal Specifiers

static IContentBrowserSingleton & Get()

   IContentBrowserSingleton.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page