UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FWorkspaceItem Class Reference

#include <WorkspaceItem.h>

+ Inheritance diagram for FWorkspaceItem:

Classes

struct  FWorkspaceItemSort
 

Public Member Functions

TSharedRef< FWorkspaceItemAddGroup (const FText &InDisplayName, const FSlateIcon &InIcon=FSlateIcon(), const bool InSortChildren=false)
 
TSharedRef< FWorkspaceItemAddGroup (const FName &InName, const FText &InDisplayName, const FSlateIcon &InIcon=FSlateIcon(), const bool InSortChildren=false)
 
TSharedRef< FWorkspaceItemAddGroup (const FText &InDisplayName, const FText &InTooltipText, const FSlateIcon &InIcon=FSlateIcon(), const bool InSortChildren=false)
 
TSharedRef< FWorkspaceItemAddGroup (const FName &InName, const FText &InDisplayName, const FText &InTooltipText, const FSlateIcon &InIcon=FSlateIcon(), const bool InSortChildren=false)
 
const FName GetFName () const
 
const FTextGetDisplayName () const
 
const FTextGetTooltipText () const
 
const FSlateIconGetIcon () const
 
const TArray< TSharedRef< FWorkspaceItem > > & GetChildItems () const
 
void AddItem (const TSharedRef< FWorkspaceItem > &ItemToAdd)
 
void RemoveItem (const TSharedRef< FWorkspaceItem > &ItemToRemove)
 
void ClearItems ()
 
void SortChildren ()
 
virtual TSharedPtr< FTabSpawnerEntryAsSpawnerEntry ()
 
TSharedPtr< FWorkspaceItemGetParent () const
 
bool HasChildrenIn (const TArray< TWeakPtr< FTabSpawnerEntry > > &AllowedSpawners)
 
virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS ~FWorkspaceItem ()
 
- Public Member Functions inherited from TSharedFromThis< FWorkspaceItem >
TSharedRef< FWorkspaceItem, Mode > AsShared ()
 
TSharedRef< FWorkspaceItem const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< FWorkspaceItem, Mode > AsWeak ()
 
TWeakPtr< FWorkspaceItem const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Static Public Member Functions

static TSharedRef< FWorkspaceItemNewGroup (const FText &DisplayName, const FSlateIcon &Icon=FSlateIcon(), const bool bSortChildren=false)
 
static TSharedRef< FWorkspaceItemNewGroup (const FName &Name, const FText &DisplayName, const FSlateIcon &Icon=FSlateIcon(), const bool bSortChildren=false)
 
static TSharedRef< FWorkspaceItemNewGroup (const FText &DisplayName, const FText &TooltipText, const FSlateIcon &Icon=FSlateIcon(), const bool bSortChildren=false)
 
static TSharedRef< FWorkspaceItemNewGroup (const FName &Name, const FText &DisplayName, const FText &TooltipText, const FSlateIcon &Icon=FSlateIcon(), const bool bSortChildren=false)
 

Protected Member Functions

 FWorkspaceItem (const FText &InDisplayName, const FSlateIcon &InIcon, const bool bInSortChildren)
 
 FWorkspaceItem (const FName &InName, const FText &InDisplayName, const FSlateIcon &InIcon, const bool bInSortChildren)
 
 FWorkspaceItem (const FText &InDisplayName, const FText &InTooltipText, const FSlateIcon &InIcon, const bool bInSortChildren)
 
 FWorkspaceItem (const FName &InName, const FText &InDisplayName, const FText &InTooltipText, const FSlateIcon &InIcon, const bool bInSortChildren)
 
- Protected Member Functions inherited from TSharedFromThis< FWorkspaceItem >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 

Protected Attributes

FSlateIcon Icon
 
TAttribute< FNameNameAttribute
 
TAttribute< FTextDisplayNameAttribute
 
TAttribute< FTextTooltipTextAttribute
 
FText DisplayName
 
FText TooltipText
 
bool bSortChildren
 
TArray< TSharedRef< FWorkspaceItem > > ChildItems
 
TWeakPtr< FWorkspaceItemParentItem
 

Friends

template<typename ObjectType , ESPMode Mode>
class SharedPointerInternals::TIntrusiveReferenceController
 

Additional Inherited Members

- Static Protected Member Functions inherited from TSharedFromThis< FWorkspaceItem >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Constructor & Destructor Documentation

◆ ~FWorkspaceItem()

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS FWorkspaceItem::~FWorkspaceItem ( )
inlinevirtual

◆ FWorkspaceItem() [1/4]

FWorkspaceItem::FWorkspaceItem ( const FText InDisplayName,
const FSlateIcon InIcon,
const bool  bInSortChildren 
)
inlineprotected

◆ FWorkspaceItem() [2/4]

FWorkspaceItem::FWorkspaceItem ( const FName InName,
const FText InDisplayName,
const FSlateIcon InIcon,
const bool  bInSortChildren 
)
inlineprotected

◆ FWorkspaceItem() [3/4]

FWorkspaceItem::FWorkspaceItem ( const FText InDisplayName,
const FText InTooltipText,
const FSlateIcon InIcon,
const bool  bInSortChildren 
)
inlineprotected

◆ FWorkspaceItem() [4/4]

FWorkspaceItem::FWorkspaceItem ( const FName InName,
const FText InDisplayName,
const FText InTooltipText,
const FSlateIcon InIcon,
const bool  bInSortChildren 
)
inlineprotected

Member Function Documentation

◆ AddGroup() [1/4]

TSharedRef< FWorkspaceItem > FWorkspaceItem::AddGroup ( const FName InName,
const FText InDisplayName,
const FSlateIcon InIcon = FSlateIcon(),
const bool  InSortChildren = false 
)
inline

◆ AddGroup() [2/4]

TSharedRef< FWorkspaceItem > FWorkspaceItem::AddGroup ( const FName InName,
const FText InDisplayName,
const FText InTooltipText,
const FSlateIcon InIcon = FSlateIcon(),
const bool  InSortChildren = false 
)
inline

◆ AddGroup() [3/4]

TSharedRef< FWorkspaceItem > FWorkspaceItem::AddGroup ( const FText InDisplayName,
const FSlateIcon InIcon = FSlateIcon(),
const bool  InSortChildren = false 
)
inline

◆ AddGroup() [4/4]

TSharedRef< FWorkspaceItem > FWorkspaceItem::AddGroup ( const FText InDisplayName,
const FText InTooltipText,
const FSlateIcon InIcon = FSlateIcon(),
const bool  InSortChildren = false 
)
inline

◆ AddItem()

void FWorkspaceItem::AddItem ( const TSharedRef< FWorkspaceItem > &  ItemToAdd)
inline

◆ AsSpawnerEntry()

virtual TSharedPtr< FTabSpawnerEntry > FWorkspaceItem::AsSpawnerEntry ( )
inlinevirtual

Reimplemented in FTabSpawnerEntry.

◆ ClearItems()

void FWorkspaceItem::ClearItems ( )
inline

◆ GetChildItems()

const TArray< TSharedRef< FWorkspaceItem > > & FWorkspaceItem::GetChildItems ( ) const
inline

◆ GetDisplayName()

const FText & FWorkspaceItem::GetDisplayName ( ) const
inline

◆ GetFName()

const FName FWorkspaceItem::GetFName ( ) const
inline

◆ GetIcon()

const FSlateIcon & FWorkspaceItem::GetIcon ( ) const
inline

◆ GetParent()

TSharedPtr< FWorkspaceItem > FWorkspaceItem::GetParent ( ) const
inline

◆ GetTooltipText()

const FText & FWorkspaceItem::GetTooltipText ( ) const
inline

◆ HasChildrenIn()

bool FWorkspaceItem::HasChildrenIn ( const TArray< TWeakPtr< FTabSpawnerEntry > > &  AllowedSpawners)
inline

◆ NewGroup() [1/4]

static TSharedRef< FWorkspaceItem > FWorkspaceItem::NewGroup ( const FName Name,
const FText DisplayName,
const FSlateIcon Icon = FSlateIcon(),
const bool  bSortChildren = false 
)
inlinestatic

◆ NewGroup() [2/4]

static TSharedRef< FWorkspaceItem > FWorkspaceItem::NewGroup ( const FName Name,
const FText DisplayName,
const FText TooltipText,
const FSlateIcon Icon = FSlateIcon(),
const bool  bSortChildren = false 
)
inlinestatic

◆ NewGroup() [3/4]

static TSharedRef< FWorkspaceItem > FWorkspaceItem::NewGroup ( const FText DisplayName,
const FSlateIcon Icon = FSlateIcon(),
const bool  bSortChildren = false 
)
inlinestatic

◆ NewGroup() [4/4]

static TSharedRef< FWorkspaceItem > FWorkspaceItem::NewGroup ( const FText DisplayName,
const FText TooltipText,
const FSlateIcon Icon = FSlateIcon(),
const bool  bSortChildren = false 
)
inlinestatic

◆ RemoveItem()

void FWorkspaceItem::RemoveItem ( const TSharedRef< FWorkspaceItem > &  ItemToRemove)
inline

◆ SortChildren()

void FWorkspaceItem::SortChildren ( )
inline

Friends And Related Symbol Documentation

◆ SharedPointerInternals::TIntrusiveReferenceController

Member Data Documentation

◆ bSortChildren

bool FWorkspaceItem::bSortChildren
protected

◆ ChildItems

TArray< TSharedRef<FWorkspaceItem> > FWorkspaceItem::ChildItems
protected

◆ DisplayName

FText FWorkspaceItem::DisplayName
protected

◆ DisplayNameAttribute

TAttribute<FText> FWorkspaceItem::DisplayNameAttribute
protected

◆ Icon

FSlateIcon FWorkspaceItem::Icon
protected

◆ NameAttribute

TAttribute<FName> FWorkspaceItem::NameAttribute
protected

◆ ParentItem

TWeakPtr<FWorkspaceItem> FWorkspaceItem::ParentItem
protected

◆ TooltipText

FText FWorkspaceItem::TooltipText
protected

◆ TooltipTextAttribute

TAttribute<FText> FWorkspaceItem::TooltipTextAttribute
protected

The documentation for this class was generated from the following file: