FContentBrowserItem

Representation of a Content Browser item.

Choose your operating system:

Windows

macOS

Linux

References

Module

ContentBrowserData

Header

/Engine/Source/Editor/ContentBrowserData/Public/ContentBrowserItem.h

Include

#include "ContentBrowserItem.h"

Syntax

struct FContentBrowserItem

Remarks

Representation of a Content Browser item.

FContentBrowserItem is potentially a composite of multiple internal items (eg, combining equivalent folder items from different data sources), and defers back to these internal items to provide its functionality (via the data source that owns each internal item).

Constructors

Name Description

Public function

FContentBrowserItem()

Default constructor.

Public function

FContentBrowserItem

(
    FContentBrowserItemData&& InItem
)

Construct this composite item from the given internal item(s).

Public function

FContentBrowserItem

(
    const FContentBrowserItemData& InI...
)

Default constructor.

Public function

FContentBrowserItem

(
    TArrayView< const FContentBrowserIt...
)

Default constructor.

Public function

FContentBrowserItem

(
    const FContentBrowserItem&
)

Copy support.

Public function

FContentBrowserItem

(
    FContentBrowserItem&&
)

Move support.

Functions

Name Description

Public function

void

 

Append

(
    const FContentBrowserItem& InOther
)

Append the given item to this one, asserting if the combination isn't possible.

Public function

void

 

Append

(
    const FContentBrowserItemData& InO...
)

Append the given item to this one, asserting if the combination isn't possible.

Public function Const

bool

 

AppendItemReference

(
    FString& InOutStr
)

Attempt to append any path references for this item to the given string.

Public function Const

bool

 

CanCopy

(
    const FName InDestPath,
    FText* OutErrorMsg
)

Query whether this item is can be copied, optionally providing error information if it cannot.

Public function Const

bool

 

CanDelete

(
    FText* OutErrorMsg
)

Query whether this item is can be deleted, optionally providing error information if it cannot.

Public function Const

bool

 

CanDuplicate

(
    FText* OutErrorMsg
)

Query whether this item is can be duplicated, optionally providing error information if it cannot.

Public function Const

bool

 

CanEdit

(
    FText* OutErrorMsg
)

Query whether this item is can be edited, optionally providing error information if it cannot.

Public function Const

bool

 

CanMove

(
    const FName InDestPath,
    FText* OutErrorMsg
)

Query whether this item is can be moved, optionally providing error information if it cannot.

Public function Const

bool

 

CanPreview

(
    FText* OutErrorMsg
)

Query whether this item is can be previewed, optionally providing error information if it cannot.

Public function Const

bool

 

CanRename

(
    const FString* InNewName,
    FText* OutErrorMsg
)

Query whether this item is can be renamed, optionally providing error information if it cannot.

Public function Const

bool

 

CanSave

(
    const EContentBrowserItemSaveFlags ...,
    FText* OutErrorMsg
)

Query whether this item is can be saved, optionally providing error information if it cannot.

Public function Const

bool

 

Copy

(
    const FName InDestPath
)

Attempt to copy this item to the given virtual path.

Public function Const

bool

 

Delete()

Attempt to delete this item.

Public function Const

FContentBrow...

 

Duplicate()

Attempt to begin the process of asynchronously duplicating this item, populating a temporary item that can be finalized or canceled by the user.

Public function Const

bool

 

Edit()

Attempt to open this item for editing.

Public function Const

FText

 

GetDisplayName()

Get the user-facing name of this item (eg, "MyFile").

Public function Const

FItemDataArr...

 

GetInternalItems()

Get the array of internal items that comprise this composite item.

Public function Const

FName

 

GetInternalPath()

Gets the internal path if it has one (eg,. "/Game").

Public function Const

FName

 

GetInvariantPath()

Gets the path that will not change based on toggling "Show All Folder", "Organize Folders" or other rules (eg,. "/Plugins").

Public function Const

FContentBrow...

 

GetItemAttribute

(
    const FName InAttributeKey,
    const bool InIncludeMetaData
)

Query the value of the given attribute on this item.

Public function Const

FContentBrow...

 

GetItemAttributes

(
    const bool InIncludeMetaData
)

Query the values of all attributes on this item.

Public function Const

EContentBrow...

 

GetItemCategory()

Get the flags denoting the item category information for this item instance.

Public function Const

EContentBrow...

 

GetItemFlags()

Get the flags denoting basic state information for this item instance.

Public function Const

FName

 

GetItemName()

Get the leaf-name of this item (eg, "MyFile").

Public function Const

bool

 

GetItemPhysicalPath

(
    FString& OutDiskPath
)

Query the physical (on-disk) path of this item.

Public function Const

EContentBrow...

 

GetItemTemporaryReason()

Get the flags denoting the item temporary reason information for this item instance.

Public function Const

EContentBrow...

 

GetItemType()

Get the flags denoting the item type information for this item instance.

Public function Const

const FConte...

 

GetPrimaryInternalItem()

Get the primary internal item from this composite item, if any.

Public function Const

FName

 

GetVirtualPath()

Get the complete virtual path that uniquely identifies this item within its owner data source (eg, "/MyRoot/MyFolder/MyFile").

Public function Const

bool

 

IsDirty()

Query whether this item is considered dirty (ie, has unsaved changes).

Public function Const

bool

 

IsDisplayOnlyFolder()

Check to see whether this item is a display only folder.

Public function Const

bool

 

IsFile()

Check to see whether this item is a file.

Public function Const

bool

 

IsFolder()

Check to see whether this item is a folder.

Public function Const

bool

 

IsTemporary()

Check to see whether this item is temporary.

Public function Const

bool

 

IsValid()

Check to see whether this item is valid (contains at least one internal item).

Public function Const

bool

 

Legacy_TryGetAssetData

(
    FAssetData& OutAssetData
)

Attempt to retrieve the asset data associated with this item.

Public function Const

bool

 

Legacy_TryGetPackagePath

(
    FName& OutPackagePath
)

Attempt to retrieve the package path associated with this item.

Public function Const

bool

 

Move

(
    const FName InDestPath
)

Attempt to move this item to the given virtual path.

Public function Const

bool

 

Preview()

Attempt to preview this item.

Public function

void

 

Remove

(
    const FContentBrowserItemData& InO...
)

Remove the given item from this one, asserting if the removal wasn't possible.

Public function

void

 

Remove

(
    const FContentBrowserItem& InOther
)

Remove the given item from this one, asserting if the removal wasn't possible.

Public function Const

bool

 

Rename

(
    const FString& InNewName,
    FContentBrowserItem* OutNewIte...
)

Attempt to rename this item.

Public function Const

bool

 

Save

(
    const EContentBrowserItemSaveFlags ...
)

Attempt to save this item.

Public function

bool

 

TryAppend

(
    const FContentBrowserItem& InOther,
    FText* OutError
)

Attempt to append the given item to this one, providing error information if the combination isn't possible.

Public function

bool

 

TryAppend

(
    const FContentBrowserItemData& InO...,
    FText* OutError
)

Attempt to append the given item to this one, providing error information if the combination isn't possible.

Public function Const

bool

 

TryGetCollectionId

(
    FName& OutCollectionId
)

Attempt to retrieve the identifier that should be used when storing a reference to this item within a collection.

Public function

bool

 

TryRemove

(
    const FContentBrowserItem& InOther,
    FText* OutError
)

Attempt to remove the given item from this one, providing error information if the removal wasn't possible.

Public function

bool

 

TryRemove

(
    const FContentBrowserItemData& InO...,
    FText* OutError
)

Attempt to remove the given item from this one, providing error information if the removal wasn't possible.

Public function Const

bool

 

UpdateThumbnail

(
    FAssetThumbnail& InThumbnail
)

Attempt to update the thumbnail associated with this item.

Operators

Name Description

Public function

FContentBrow...

 

operator=

(
    FContentBrowserItem&&
)

Public function

FContentBrow...

 

operator=

(
    const FContentBrowserItem&
)

Typedefs

Name

Description

FItemDataArrayView