1. Epic GamesDeveloper
  3. IContentBrowserSingleton

IContentBrowserSingleton

Content browser module singleton

API > API/Editor > API/Editor/ContentBrowser

References

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

Syntax

class IContentBrowserSingleton

Remarks

Content browser module singleton

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Public function bool

CanChangeAssetPublicState ( FStringView AssetPath
)

 Returns true if the public/private state of the specified asset can be changed
Public function void

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

 Capture active viewport to thumbnail and assigns that thumbnail to incoming assets
Public function TSharedRef< SWidget >

CreateAssetPicker ( const FAssetPickerConfig& AssetPickerConfig
)

 Generates an asset picker widget locked to the specified FARFilter.
Public function TSharedRef< SWidget >

CreateCollectionPicker ( const FCollectionPickerConfig& CollectionPickerConfig
)

 Generates a collection picker widget.
Public function TSharedRef< SWidget >

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

 Generates a content browser.
Public function TSharedRef< SWidget >

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

 Generates a content browser for use in a drawer.
Public function TArray< FAssetData > Opens the Open Asset dialog in a modal window
Public function FString Opens the Save Asset dialog in a modal window
Public function 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
Public function void

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

 Opens the Open Asset dialog in a non-modal window
Public function TSharedRef< SWidget >

CreatePathPicker ( const FPathPickerConfig& PathPickerConfig
)

 Generates a path picker widget.
Public function void

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

 Opens the Save Asset dialog in a non-modal window
Public function void

ExecuteAddFolder ( TSharedPtr< SWidget > PathPickerWidget
)

 Add a folder to the path picker widget under the current selected path.
Public function void

ExecuteRename ( TSharedPtr< SWidget > PickerWidget
)

 Rename current first selected content item on the passed in widget.
Public function void

FocusContentBrowserSearchField ( TSharedPtr< SWidget > ContentBrowserWidget
)

 Focuses the search field of a content browser widget
Public function void

FocusPrimaryContentBrowser ( bool bFocusSearch
)

 Brings the primary content browser to the front or opens one if it does not exist.
Public function void

ForceShowPluginContent ( bool bEnginePlugin
)

 Forces the content browser to show plugin content if it's not already showing.
Public function Static IContentBrowserSingleton &

Get ()

  
Public function TSharedPtr< SWidget >

GetAssetPickerSearchBox ( const TSharedRef< SWidget >& AssetPickerWidget
)

 Focus the search box of the given asset picker widget.
Public function FContentBrowserItemPath Gets the current path if one exists, otherwise returns empty string.
Public function FContentBrowserItemPath Returns InPath if can be written to, otherwise picks a default path that can be written to
Public function void

GetSelectedAssets ( TArray< FAssetData >& SelectedAssets
)

 Generates a list of assets that are selected in the primary content browser
Public function void

GetSelectedFolders ( TArray< FString >& SelectedFolders
)

 Generates a list of folders that are selected in the primary content browser
Public function void

GetSelectedPathViewFolders ( TArray< FString >& SelectedFolders
)

 Returns the folders that are selected in the path view
Public function const TSharedPtr< FPathPermissionList > & Returns the Private Content Permission List
Public function Const bool Returns true if there is at least one browser open that is eligible to be a primary content browser
Public function bool

IsFolderShowPrivateContentToggleable ( const FStringView VirtualFolderPath
)

 Returns true if FolderPath's private content edit mode is allowed to be toggled
Public function bool

IsShowingPrivateContent ( const FStringView VirtualFolderPath
)

 Returns true if FolderPath is a private content edit folder
Public function void

RefreshPathView ( TSharedPtr< SWidget > PathPickerWidget
)

 Force refresh on the path picker widget.
Public function void

RegisterCanChangeAssetPublicStateDelegate ( FCanChangeAssetPublicStateDelegate InCanChangeAssetPublicStateDelegate
)

 Registers the delegate called to determine whether the public/private state of the specified asset can be changed
Public function void

RegisterIsFolderShowPrivateContentToggleableDelegate ( FIsFolderShowPrivateContentToggleableDelegate InIsFolderShowPrivateContentToggleableDelegate
)

 Registers the delegate for custom handling of if a Folder allows private content edits
Public function FDelegateHandle

RegisterOnFavoritesChangedHandler ( FSimpleDelegate OnFavoritesChanged
)

 Register a delegate to be called when the Favorites changes.
Public function void

SaveContentBrowserSettings ( TSharedPtr< SWidget > ContentBrowserWidget
)

 Saves the settings for a particular content browser instance
Public function void Declares the Private Content Permission List dirty
Public function void

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

 Sets the content browser to display the selected paths
Public function void

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

 Selects the supplied assets in the primary content browser.
Public function 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.
Public function void

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

 Selects the supplied assets in the primary content browser.
Public function void

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

 Selects the supplied assets in the primary content browser.
Public function void

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

 Selects the supplied items in the primary content browser.
Public function void Unregisters the delegate called to determine whether the public/private state of the specified asset can be changed
Public function void Unregisters the delegate for custom handling of if a Folder allows private content edits
Public function void Unregister a previously-registered handler for when Favorites changes.

Deprecated Functions

  Type Name Description
Public function FString

GetCurrentPath ( const EContentBrowserPathType PathType
)

 This function is deprecated. Use GetCurrentPath without argument instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page