1. Epic GamesDeveloper
  3. ConcertSharedSlate

ConcertSharedSlate

API > API/Plugins

   
Name ConcertSharedSlate
Type Developer
Part of Plugins Concert Shared Slate
Location /Engine/Plugins/Developer/Concert/ConcertUI/ConcertSharedSlate/Source/ConcertSharedSlate/
Module Build Rules ConcertSharedSlate.Build.cs

Classes

Name Remarks
FAbstractSessionHistoryController Acts as controller of SSessionHistory in model-view-component pattern.
FActivityColumn A column in SConcertSessionActivities
FColumnVisibilityTransaction Helper for temporarily setting column visibilities to a certain setting.
FConcertActiveGroupTreeItem Groups several active sessions
FConcertArchivedGroupTreeItem Groups archived sessions
FConcertFrontendStyle  
FConcertGroupTreeItem Groups several FConcertSessionTreeItem
FConcertSessionActivitiesOptions Manages the various options exposed by SConcertSessionActivities widget such as enabling/disabling filtering, changing the time format, etc.
FConcertSessionTreeItem An item that represents a session, i.e. has session info.
FConcertTreeItem Base class for everything displayed in session view
FEditableStreamModelProxy Base util class for implementations that alter or extend the behavior of another IEditableReplicationStreamModel.
FPropertyData Instanced for each property row in IPropertyTreeView.
FReplicatedObjectData Instanced for each object row in stream viewer / editor UI.
SClientName Knows how to display FConcertClientInfo.
SConcertScrollBox  
SConcertSessionActivities Displays session activities in a table view.
SConcertSessionBrowser Enables the user to browse/search/filter/sort active and archived sessions, create new session, archive active sessions, restore archived sessions, join a session and open the settings dialog.
SConcertSessionRecovery Displays the list of activities available for recovery and let the user select what should or shouldn't be recovered.
SEditableSessionHistory Allows activities in the session history to be deleted.
SHorizontalClientList Aligns client widgets from left to right.
SLocalClientName Displays the name of a client.The name will look like "Client Name (me)".
SPackageDetails  
SRemoteClientName Displays the name of a client.
SSessionHistory Wraps a session table list with a search box and a status bar for visibility settings (show connection activities, etc.).
SSessionHistoryWrapper Shows a SSessionHistory widget - keeping alive the controller as long as this widget lives.
UConcertSessionBrowserSettings Serializes the multi-user session browser settings like the active filters.

Structs

Name Remarks
FBaseDisplayInfo  
FCanPerformActionResult  
FCategoryRowGenerationArgs  
FColumnSortInfo Info about a column that is being sorted.
FColumnVisibilitySnapshot  
FCreateEditorParams Params for creating an IReplicationStreamEditor
FCreateMultiObjectAssignmentViewParams  
FCreateMultiStreamEditorParams Params for creating an IMultiReplicationStreamEditor
FCreatePerObjectAssignmentViewParams  
FCreatePropertyTreeViewParams  
FCreateViewerParams Params for creating a IReplicationStreamViewer.
FObjectGroup An object group is a bunch of related objects.
FObjectTreeRowContext Holds information relevant to a row.
FPropertyAssignmentEntry  
FPropertyInfo Wraps FConcertPropertyChain so it is easier to potentially change what IPropertySource lists in the future.
FPropertySourceContext Arguments for getting properties associated with an object / class.
FPropertyTreeRowContext Holds information relevant to a row.
FReplicationColumnInfo Meta information about a column that can change independent of the IReplicationTreeColumn implementation.
FSelectableObjectInfo Info about a selectable object
FSourceDisplayInfo  
FSourceModelBuilders Utility for creating widgets of IItemSourceModel and categories thereof (TSourceSelectionCategory).
TCheckboxColumnDelegates  
TReplicationColumnDelegates  
TReplicationColumnEntry  
TSourceSelectionCategory A category groups IItemSourceModel together, e.g. a category "Add actor" could have options like

Interfaces

Name Remarks
ICategoryRow A special reassignment view which shows the display object and all its children.
IConcertReflectionDataProvider Passed on to SUndoHistoryDetails to display reflection data in non-editor builds.
IConcertSessionBrowserController Runs and cache network queries for the UI.
IConcertSharedSlateModule Interface for the Concert Sync UI module.
IEditableMultiReplicationStreamModel Model for UI editing multiple streams at the same time.
IEditableReplicationStreamModel Abstracts the concept of mapping objects to properties.
IItemSourceModel Defines the source for of item, e.g. objects.
IMultiObjectPropertyAssignmentView A special reassignment view which shows the display object and all its children.
IMultiReplicationStreamEditor Widget which edits multiple replication stream.
IMultiReplicationStreamModel Model for UI displaying multiple streams at the same time.
IObjectHierarchyModel Determines the parent-child relationship between objects.
IObjectNameModel Abstracts the concept of getting an object's display name.
IObjectSelectionSourceModel Decides which objects can be added to a IEditableReplicationStreamModel.
IPropertyAssignmentView A replication assignment view displays an object's properties.
IPropertySource Lists out a bunch of properties.
IPropertySourceProcessor Determines the properties that should be displayed for an Object / Class.
IPropertyTreeView Represents a tree view displaying properties from a single class.
IReplicationStreamEditor Widget which edits replication stream.
IReplicationStreamModel Abstracts the concept of mapping objects to properties.
IReplicationStreamViewer Widget which views a replication stream.
IStreamExtender When an object is added to IEditableReplicationStreamModel, these functions are called to allow adding additional objects and properties.
IStreamExtensionContext Allows IStreamExtender to add default replication settings like properties and adding additional objects.

Typedefs

Name Type Remarks Include Path
FCanRemoveSessions TBaseDelegate_OneParam< bool, const TArray< TSharedPtr< FConcertSessionTreeItem > > & >   Session/Browser/SConcertSessionBrowser.h
FClientSortPredicate TBaseDelegate_TwoParams< bool, const FConcertSessionClientInfo &Left, const FConcertSessionClientInfo &Right >   Widgets/Client/ClientSorting.h
FCreateCategoryRow TBaseDelegate_OneParam< TSharedRef< ICategoryRow >, const FCategoryRowGenerationArgs &Args >   Replication/Editor/View/Extension/CategoryRowGeneration.h
FExtenderDelegate TBaseDelegate_OneParam< void, FExtender & >   Session/Browser/SConcertSessionBrowser.h
FExtendObjectMenu TBaseDelegate_TwoParams< void, FMenuBuilder &, TConstArrayView< TSoftObjectPtr<> > ContextObjects > Extends a context menu that is being built for a selection of objects. Replication/Utils/ReplicationWidgetDelegates.h
FExtendSessionContextMenu TBaseDelegate_TwoParams< void, const TSharedPtr< FConcertSessionTreeItem > &, FExtender & >   Session/Browser/SConcertSessionBrowser.h
FExtendSessionTable TBaseDelegate_OneParam< TSharedRef< SWidget >, const TSharedRef< SWidget > & >   Session/Browser/SConcertSessionBrowser.h
FFilterPropertyData TBaseDelegate_OneParam< EFilterResult, const FPropertyData & >   Replication/PropertyAssignmentViewFactory.h
FGetAutoAssignTarget TBaseDelegate_OneParam< TSharedPtr< IEditableReplicationStreamModel >, TConstArrayView< UObject * > >   Replication/ReplicationWidgetFactories.h
FGetClientParenthesesContent TBaseDelegate_OneParam< FText, const FGuid &ClientId > Used by SHorizontalList to determine what should go in the parentheses behind the display name, e.g. "Display Name (You)". Widgets/Client/ClientInfoDelegate.h
FGetObjectClass TBaseDelegate_OneParam< FSoftClassPath, const TSoftObjectPtr<> & > Delegate for getting an object's class. Replication/Utils/ReplicationWidgetDelegates.h
FGetOptionalClientInfo TBaseDelegate_OneParam< TOptional< FConcertClientInfo >, const FGuid &ClientEndpointId >   Widgets/Client/ClientInfoDelegate.h
FIsLocalClient TBaseDelegate_OneParam< bool, const FGuid &ClientId >   Widgets/Client/ClientInfoDelegate.h
FMakeObjectRowOverlayWidget TBaseDelegate_OneParam< TSharedRef< SWidget >, const FReplicatedObjectData &ObjectData > Delegate executed to create a widget that overlays an object row. Replication/Utils/ReplicationWidgetDelegates.h
FObjectColumnEntry TReplicationColumnEntry< FObjectTreeRowContext >   Replication/Editor/View/Column/IObjectTreeColumn.h
FObjectSourceCategory ConcertSharedSlate::TSourceSelectionCategory< FSelectableObjectInfo >   Replication/Editor/Model/ObjectSource/IObjectSelectionSourceModel.h
FOnBeginEditConcertSessionNameRequest TMulticastDelegate_NoParams< void > Signal emitted when a session name text field should enter in edit mode. Session/Browser/Items/ConcertSessionTreeItem.h
FPropertyColumnEntry TReplicationColumnEntry< FPropertyTreeRowContext >   Replication/Editor/View/Column/IPropertyTreeColumn.h
FSaveColumnVisibilitySnapshot TBaseDelegate_OneParam< void, const FColumnVisibilitySnapshot & >   ConcertHeaderRowUtils.h
FSelectObjectsFromComboButton TBaseDelegate_OneParam< void, TConstArrayView< FSelectableObjectInfo > > Delegate executed when object options are selected from the Add button to the left of the search bar in the top view of the replication panel. Replication/Utils/ReplicationWidgetDelegates.h
FSessionDelegate TBaseDelegate_OneParam< void, const TSharedPtr< FConcertSessionTreeItem > & >   Session/Browser/SConcertSessionBrowser.h
FSessionListDelegate TBaseDelegate_OneParam< void, const TArray< TSharedPtr< FConcertSessionTreeItem > > & >   Session/Browser/SConcertSessionBrowser.h
FShouldDisplayObject TBaseDelegate_OneParam< bool, const FSoftObjectPath &ObjectPath > Delegate for deciding whether an object should be displayed. Replication/Utils/ReplicationWidgetDelegates.h
FSortPropertyPredicate TBaseDelegate_TwoParams< bool, const FPropertyData &Left, const FPropertyData &Right > A predicate for determining Left < Right. Replication/Utils/ReplicationWidgetDelegates.h
FWrapOutlinerWidget TBaseDelegate_OneParam< TSharedRef< SWidget >, const TSharedRef< SWidget > &OutlinerWidget > Delegate executed during construction of UI. Replication/Utils/ReplicationWidgetDelegates.h
IObjectSourceModel ConcertSharedSlate::IItemSourceModel< FSelectableObjectInfo > A specific object source, e.g. like actors, components from an actor (right-click), etc. Replication/Editor/Model/ObjectSource/IObjectSourceModel.h
IObjectTreeColumn IReplicationTreeColumn< FObjectTreeRowContext >   Replication/Editor/View/Column/IObjectTreeColumn.h
IPropertyTreeColumn IReplicationTreeColumn< FPropertyTreeRowContext >   Replication/Editor/View/Column/IPropertyTreeColumn.h

Enums

Public

Name Remarks
EConcertActivityFilterFlags Filters for the concert session activity view.
ETimeFormat Defines how the time should be displayed in the date/time column.
UE::ConcertSharedSlate::ActivityColumn::EPredefinedColumnOrder Contains factories for commonly used columns.
UE::ConcertSharedSlate::EChildRelationship Describes the kind of relationship a child object can have to its parent object
UE::ConcertSharedSlate::EChildRelationshipFlags Similar to EChildRelationship. Used for filtering using bit flags.
UE::ConcertSharedSlate::EFilterResult These functions build widgets for selecting options.
UE::ConcertSharedSlate::EItemPickerFlags These functions build widgets for selecting options.
UE::ConcertSharedSlate::EObjectItemValidity These functions build widgets for selecting options.
UE::ConcertSharedSlate::EReplicatedObjectChangeReason These functions build widgets for selecting options.
UE::ConcertSharedSlate::ESourceType These functions build widgets for selecting options.
UE::ConcertSharedSlate::ReplicationColumns::Property::EReplicationPropertyColumnOrder  
UE::ConcertSharedSlate::ReplicationColumns::TopLevel::ENumPropertiesFlags  
UE::ConcertSharedSlate::ReplicationColumns::TopLevel::ETopLevelColumnOrder  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
pad0 PRAGMA_DISABLE_DEPRECATION_WARNINGS Decides which properties can be added to a IReplicationStreamModel. Replication/Editor/Model/Property/IPropertySelectionSourceModel.h  
AvatarColorColumnId const FName   Session/Activity/PredefinedActivityColumns.h  
ClientNameColumnId const FName   Session/Activity/PredefinedActivityColumns.h  
DateTimeColumnId const FName   Session/Activity/PredefinedActivityColumns.h  
OperationColumnId const FName   Session/Activity/PredefinedActivityColumns.h  
PackageColumnId const FName   Session/Activity/PredefinedActivityColumns.h  
SummaryColumnId const FName   Session/Activity/PredefinedActivityColumns.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FText ConcertBrowserUtils::GetServerVersionIgnoredTooltip()

 Returns the tooltip shown when hovering the triangle with an exclamation icon when a server doesn't validate the version requirements. Session/Browser/ConcertBrowserUtils.h  

TSharedRef< SWidget > ConcertBrowserUtils::MakeIconButton ( const TAttribute< const FSlateBrush* >& Icon,
const TAttribute< FText >& Tooltip,
const TAttribute< bool >& EnabledAttribute,
const FOnClicked& OnClicked,
const TAttribute< EVisibility >& Visibility
)

 Utility function used to create buttons displaying only an icon (using a brush) Session/Browser/ConcertBrowserUtils.h  

TSharedRef< SWidget > ConcertBrowserUtils::MakeNegativeActionButton ( const TAttribute< const FSlateBrush* >& Icon,
const TAttribute< FText >& Tooltip,
const TAttribute< bool >& EnabledAttribute,
const FOnClicked& OnClicked,
const TAttribute< EVisibility >& Visibility
)

 Utility function used to create buttons displaying a negative action Session/Browser/ConcertBrowserUtils.h  

TSharedRef< SWidget > ConcertBrowserUtils::MakePositiveActionButton ( const TAttribute< const FSlateBrush* >& Icon,
const TAttribute< FText >& Tooltip,
const TAttribute< bool >& EnabledAttribute,
const FOnClicked& OnClicked,
const TAttribute< EVisibility >& Visibility
)

 Utility function used to create buttons displaying a positive action Session/Browser/ConcertBrowserUtils.h  

TSharedRef< SWidget > ConcertBrowserUtils::MakeServerVersionIgnoredWidget ( EConcertServerFlags InServerFlags
)

 Create a widget displaying the triangle with an exclamation icon in case the server flags include IgnoreSessionRequirement. Session/Browser/ConcertBrowserUtils.h  

void ConcertBrowserUtils::RequestItemDeletion ( IConcertSessionBrowserController& Controller,
const TArray< TSharedPtr< FConcertSessionTreeItem > >& SessionItems
)

 Helper function to split an array of FConcertSessionItems into multiple requests and execute Session/Browser/ConcertBrowserUtils.h  

TArray< TSharedPtr< ItemType > > ConcertFrontendUtils::DeepCopyArray ( const TArray< TSharedPtr< ItemType > >& InArray
)

   ConcertFrontendUtils.h  

TArray< TSharedPtr< ItemType > > ConcertFrontendUtils::DeepCopyArrayAndClearSource ( TArray< TSharedPtr< ItemType > >& InOutArray
)

   ConcertFrontendUtils.h  

const FSlateBrush * ConcertFrontendUtils::GetExpandableAreaBorderImage ( const SExpandableArea& Area
)

 Returns the image used to render the expandable area title bar with respect to its hover/expand state. ConcertFrontendUtils.h  

void ConcertFrontendUtils::SyncArraysByPredicate ( TArray< TSharedPtr< ItemType > >& InOutArray,
TArray< TSharedPtr< ItemType > >&& InNewArray,
const PredFactoryType& InPredFactory
)

   ConcertFrontendUtils.h  

bool operator! ( EConcertActivityFilterFlags E
)

   Session/Activity/SConcertSessionActivities.h  
  Session/Activity/SConcertSessionActivities.h  
  Session/Activity/SConcertSessionActivities.h  
  Session/Activity/SConcertSessionActivities.h  
  Session/Activity/SConcertSessionActivities.h  
  Session/Activity/SConcertSessionActivities.h  
  Session/Activity/SConcertSessionActivities.h  
  Session/Activity/SConcertSessionActivities.h  

virtual UE::ConcertSharedSlate::~IPropertySelectionSourceModel()

   Replication/Editor/Model/Property/IPropertySelectionSourceModel.h  

FActivityColumn UE::ConcertSharedSlate::ActivityColumn::AvatarColor()

 Optional. Session/Activity/PredefinedActivityColumns.h  

FActivityColumn UE::ConcertSharedSlate::ActivityColumn::ClientName()

   Session/Activity/PredefinedActivityColumns.h  

FActivityColumn UE::ConcertSharedSlate::ActivityColumn::DateTime()

 Required. Session/Activity/PredefinedActivityColumns.h  

FActivityColumn UE::ConcertSharedSlate::ActivityColumn::Operation()

   Session/Activity/PredefinedActivityColumns.h  

FActivityColumn UE::ConcertSharedSlate::ActivityColumn::Package()

   Session/Activity/PredefinedActivityColumns.h  

FActivityColumn UE::ConcertSharedSlate::ActivityColumn::Summary()

   Session/Activity/PredefinedActivityColumns.h  

FText UE::ConcertSharedSlate::EvaluateGetClientParenthesesContent ( const FGetClientParenthesesContent& Getter,
const FGuid& ClientId
)

   Widgets/Client/ClientInfoDelegate.h  

UE::ConcertSharedSlate::template TReplicationColumnEntry< TListItemType > UE::ConcertSharedSlate::MakeCheckboxColumn ( FName ColumnId,
TCheckboxColumnDelegates< TListItemType > Delegates,
FText DefaultLabel,
const int32 Priority,
const float ColumnWidth
)

 Util for making a checkbox column Replication/Editor/View/Column/ReplicationColumnsUtils.h  
  Model/Item/SourceModelBuilders.h  
  Replication/Editor/Model/Object/IObjectHierarchyModel.h  
  Model/Item/SourceModelBuilders.h  
  Replication/Editor/Model/Object/IObjectHierarchyModel.h  
  Model/Item/SourceModelBuilders.h  
  Replication/Editor/Model/Object/IObjectHierarchyModel.h  
  Model/Item/SourceModelBuilders.h  
  Replication/Editor/Model/Object/IObjectHierarchyModel.h  
  Model/Item/SourceModelBuilders.h  
  Replication/Editor/Model/Object/IObjectHierarchyModel.h  
  Model/Item/SourceModelBuilders.h  
  Replication/Editor/Model/Object/IObjectHierarchyModel.h  
  Model/Item/SourceModelBuilders.h  
  Replication/Editor/Model/Object/IObjectHierarchyModel.h  
  Model/Item/SourceModelBuilders.h  
  Replication/Editor/Model/Object/IObjectHierarchyModel.h  

bool UE::ConcertSharedSlate::ReplicationColumns::TopLevel::operator! ( ENumPropertiesFlags E
)

   Replication/Editor/View/Column/SelectionViewerColumns.h  

ENumPropertiesFlags UE::ConcertSharedSlate::ReplicationColumns::TopLevel::operator& ( ENumPropertiesFlags Lhs,
ENumPropertiesFlags Rhs
)

   Replication/Editor/View/Column/SelectionViewerColumns.h  

ENumPropertiesFlags & UE::ConcertSharedSlate::ReplicationColumns::TopLevel::operator&= ( ENumPropertiesFlags& Lhs,
ENumPropertiesFlags Rhs
)

   Replication/Editor/View/Column/SelectionViewerColumns.h  

ENumPropertiesFlags UE::ConcertSharedSlate::ReplicationColumns::TopLevel::operator^ ( ENumPropertiesFlags Lhs,
ENumPropertiesFlags Rhs
)

   Replication/Editor/View/Column/SelectionViewerColumns.h  

ENumPropertiesFlags & UE::ConcertSharedSlate::ReplicationColumns::TopLevel::operator^= ( ENumPropertiesFlags& Lhs,
ENumPropertiesFlags Rhs
)

   Replication/Editor/View/Column/SelectionViewerColumns.h  

ENumPropertiesFlags UE::ConcertSharedSlate::ReplicationColumns::TopLevel::operator| ( ENumPropertiesFlags Lhs,
ENumPropertiesFlags Rhs
)

   Replication/Editor/View/Column/SelectionViewerColumns.h  

ENumPropertiesFlags & UE::ConcertSharedSlate::ReplicationColumns::TopLevel::operator|= ( ENumPropertiesFlags& Lhs,
ENumPropertiesFlags Rhs
)

   Replication/Editor/View/Column/SelectionViewerColumns.h  

ENumPropertiesFlags UE::ConcertSharedSlate::ReplicationColumns::TopLevel::operator~ ( ENumPropertiesFlags E
)

   Replication/Editor/View/Column/SelectionViewerColumns.h  

bool UE::ConcertSharedSlate::SortLocalClientParenthesesFirstThenThenAlphabetical ( const FConcertSessionClientInfo& Left,
const FConcertSessionClientInfo& Right,
const FGetClientParenthesesContent& GetClientParenthesesContent
)

 Sorts anything that has "You" in the parentheses first. Widgets/Client/ClientSorting.h  

bool UE::ConcertSharedSlate::SortSpecifiedParenthesesFirstThenThenAlphabetical ( const FConcertSessionClientInfo& Left,
const FConcertSessionClientInfo& Right,
const FGetClientParenthesesContent& GetClientParenthesesContent,
const FText& ParenthesesContentToPlaceFirst
)

 Predicate for sorting everything that has ParenthesesContentToPlaceFirst first, and then sorts everything alphabetically. Widgets/Client/ClientSorting.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FName ConcertBrowserUtils::ActiveSessionsCheckBoxMenuName ( TEXT("ActiveSessions")
)

   Session/Browser/ConcertBrowserUtils.h  

static const FName ConcertBrowserUtils::ArchivedSessionsCheckBoxMenuName ( TEXT("ArchivedSessions")
)

   Session/Browser/ConcertBrowserUtils.h  

static const FName ConcertBrowserUtils::DefaultServerCheckBoxMenuName ( TEXT("DefaultServer")
)

   Session/Browser/ConcertBrowserUtils.h  

static const FName ConcertBrowserUtils::IconColumnFontName ( TEXT("FontAwesome.9")
)

 The awesome font used to pick the icon displayed in the session list view 'Icon' column. Session/Browser/ConcertBrowserUtils.h  

static const FName ConcertBrowserUtils::LastModifiedCheckBoxMenuName ( TEXT("LastModified")
)

 Name of the filter box in the View option. Session/Browser/ConcertBrowserUtils.h  

static const FName ConcertBrowserUtils::LastModifiedColName ( TEXT("LastModified")
)

   Session/Browser/ConcertBrowserUtils.h  

static const FName ConcertBrowserUtils::ProjectColName ( TEXT("Project")
)

   Session/Browser/ConcertBrowserUtils.h  

static const FName ConcertBrowserUtils::ServerColName ( TEXT("Server")
)

   Session/Browser/ConcertBrowserUtils.h  

static const FName ConcertBrowserUtils::SessionColName ( TEXT("Session")
)

 Defines the sessions list view column tag names. Session/Browser/ConcertBrowserUtils.h  

static const FName ConcertBrowserUtils::VersionColName ( TEXT("Version")
)

   Session/Browser/ConcertBrowserUtils.h  

static TSharedRef< SComboButton > ConcertFrontendUtils::CreateViewOptionsComboButton ( FOnGetContent GetMenuContentDelegate
)

   ConcertFrontendUtils.h  

static FText ConcertFrontendUtils::FormatRelativeTime ( const FDateTime& EventTime,
const FDateTime* CurrTime
)

   ConcertFrontendUtils.h  

static FText ConcertFrontendUtils::FormatTime ( const FDateTime& Time,
ETimeFormat TimeFormat,
const FDateTime* CurrTime
)

   ConcertFrontendUtils.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page