FContentBrowserItemData

The primitive data that represents an internal Content Browser item, as defined and managed by a Content Browser data source.

Choose your operating system:

Windows

macOS

Linux

References

Module

ContentBrowserData

Header

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

Include

#include "ContentBrowserItemData.h"

Syntax

class FContentBrowserItemData

Remarks

The primitive data that represents an internal Content Browser item, as defined and managed by a Content Browser data source.

FContentBrowserItemData itself is a concrete type, so extensibility is handled via the IContentBrowserItemDataPayload interface, which can be used to store any data source defined payload data that is required to operate on the underlying thing that this item represents.

FContentBrowserItemData has no real functionality, and relies on passing itself back into the correct data source instance when asked to perform actions or validation.

@note This is the lower-level version of FContentBrowserItem, and is used internally by data sources. External code is more likely to use FContentBrowserItem directly, as that type can composite multiple internal items together (eg, combining equivalent folder items from different data sources).

Constructors

Name Description

Public function

FContentBrowserItemData()

Default constructor.

Public function

FContentBrowserItemData

(
    const FContentBrowserItemData&
)

Copy support.

Public function

FContentBrowserItemData

Move support.

Public function

FContentBrowserItemData

(
    UContentBrowserDataSource* InO...,
    EContentBrowserItemFlags InItemFlag...,
    FName InVirtualPath,
    FName InItemName,
    FText InDisplayNameOverride,
    TSharedPtr< const IContentBrowserIt...
)

Create an internal Content Browser item.

Functions

Name Description

Public function Const

FText

 

GetDisplayName()

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

Public function Const

FName

 

GetInternalPath()

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

Public function Const

FName

 

GetInvariantPath()

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

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

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

UContentBrow...

 

GetOwnerDataSource()

Get the pointer to the data source that manages the thing represented by this item.

Public function Const

TSharedPtr< ...

 

GetPayload()

Get any data source defined payload data for this item.

Public function Const

FName

 

GetVirtualPath()

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

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 (is either a folder or a file).

Operators

Name Description

Public function Const

bool

 

operator!=

(
    const FContentBrowserItemData& InO...
)

Public function

FContentBrow...

 

operator=

(
    const FContentBrowserItemData&
)

Public function

FContentBrow...

 

operator=

Public function Const

bool

 

operator==

(
    const FContentBrowserItemData& InO...
)

Comparison support.

See Also