Navigation
API > API/Plugins > API/Plugins/ConcertSharedSlate
Displays session activities in a table view.
| Name | SConcertSessionActivities |
| Type | class |
| Header File | /Engine/Plugins/Developer/Concert/ConcertUI/ConcertSharedSlate/Source/ConcertSharedSlate/Public/Session/Activity/SConcertSessionActivities.h |
| Include Path | #include "Session/Activity/SConcertSessionActivities.h" |
Syntax
class SConcertSessionActivities : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SConcertSessionActivities
- FSlateControlledConstruction → SWidget → SCompoundWidget → SConcertSessionActivities
Structs
| Name | Remarks |
|---|---|
| FArguments |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FFetchActivitiesFunc | TBaseDelegate_ThreeParams< bool, TArray< TSharedPtr< FConcertSessionActivity > > &, int32 &, FText & > | Used to pull activities from a session. | Session/Activity/SConcertSessionActivities.h |
| FGetActivityClientInfoFunc | TBaseDelegate_OneParam< TOptional< FConcertClientInfo >, FGuid > | Used to map an activity to its client. | Session/Activity/SConcertSessionActivities.h |
| FGetPackageEvent | TBaseDelegate_TwoParams< bool, const FConcertSessionActivity &, FConcertSyncPackageEventMetaData & > | Returns the package event corresponding to the package activity. | Session/Activity/SConcertSessionActivities.h |
| FGetTransactionEvent | TBaseDelegate_OneParam< TFuture< TOptional< FConcertSyncTransactionEvent > >, const FConcertSessionActivity & > | Returns the transaction event corresponding the specified activity. | Session/Activity/SConcertSessionActivities.h |
| FMakeColumnOverlayWidgetFunc | TBaseDelegate_ThreeParams< TSharedPtr< SWidget >, TWeakPtr< SMultiColumnTableRow< TSharedPtr< FConcertSessionActivity > > >, TWeakPtr< FConcertSessionActivity >, const FName & > | Used to overlay a widget over a column widget to add custom functionalities to a row. | Session/Activity/SConcertSessionActivities.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ActivitiesPerRequest | int32 | The number of activities to request when scrolling down to request activities on demand. | Session/Activity/SConcertSessionActivities.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveFilterFlags | EConcertActivityFilterFlags | Defines which activity types are currently filtered out from the view. | Session/Activity/SConcertSessionActivities.h | |
| Activities | TArray< TSharedPtr< FConcertSessionActivity > > | List of currently displayed activities. | Session/Activity/SConcertSessionActivities.h | |
| ActivityView | TSharedPtr< SListView< TSharedPtr< FConcertSessionActivity > > > | The list view widget displaying the activities. | Session/Activity/SConcertSessionActivities.h | |
| AllActivities | TArray< TSharedPtr< FConcertSessionActivity > > | List of all activities (including the filtered out ones). | Session/Activity/SConcertSessionActivities.h | |
| bActivityViewScrolled | bool | Indicate whether the activity list view was scrolled during a frame. | Session/Activity/SConcertSessionActivities.h | |
| bAllActivitiesFetched | bool | True once the activity provider function (FetchActivitiesFn) returns true. | Session/Activity/SConcertSessionActivities.h | |
| bAutoScrollDesired | bool | Whether the auto-scrolling is desired (scroll to bottom automatically unless the user scrolls somewhere else). | Session/Activity/SConcertSessionActivities.h | |
| bDarkenMutedActivities | bool | Whether to darken muted activities | Session/Activity/SConcertSessionActivities.h | |
| bDetailsAreaExpanded | bool | Keeps the expanded status of the details area. | Session/Activity/SConcertSessionActivities.h | |
| bIsUpdatingColumnVisibility | bool | Flag used to suspend saving of the column visibility while OnColumnVisibilitySettingsChanged is active to prevent infinite event recursion. | Session/Activity/SConcertSessionActivities.h | |
| bUserScrolling | bool | Whether the user is scrolling (deactivate auto-scrolling). | Session/Activity/SConcertSessionActivities.h | |
| ConcertReflectionDataProvider | TOptional< TSharedPtr< UE::ConcertSharedSlate::IConcertReflectionDataProvider > > | Provides reflection data for SUndoHistoryDetails for non-editor builds. | Session/Activity/SConcertSessionActivities.h | |
| ConnectionActivitiesVisibility | TAttribute< EVisibility > | Whether the join/leave session activities are displayed. | Session/Activity/SConcertSessionActivities.h | |
| DesiredActivitiesCount | int32 | The current desired amount of activities to display. | Session/Activity/SConcertSessionActivities.h | |
| DetailsAreaVisibility | EVisibility | Indicate if the details area should be displayed or not. | Session/Activity/SConcertSessionActivities.h | |
| ExpandableDetails | TSharedPtr< SExpandableArea > | The expandable area under which the activity details are displayed. | Session/Activity/SConcertSessionActivities.h | |
| FetchActivitiesFn | FFetchActivitiesFunc | Used to fetch more activities from an abstract source. | Session/Activity/SConcertSessionActivities.h | |
| GetActivityUserFn | FGetActivityClientInfoFunc | Used to map an activity endpoint ID to a client. May not be bound. | Session/Activity/SConcertSessionActivities.h | |
| GetPackageEventFn | FGetPackageEvent | Used to get the package event to display the selected package activity details. May not be bound. | Session/Activity/SConcertSessionActivities.h | |
| GetTransactionEventFn | FGetTransactionEvent | Used to get the transaction event to display the selected transaction activity details. | Session/Activity/SConcertSessionActivities.h | |
| HeaderRow | TSharedPtr< SHeaderRow > | Session/Activity/SConcertSessionActivities.h | ||
| HighlightText | TAttribute< FText > | Returns which text should be highlighted. | Session/Activity/SConcertSessionActivities.h | |
| IgnoredActivitiesVisibility | TAttribute< EVisibility > | Whether the ignored activities are displayed. | Session/Activity/SConcertSessionActivities.h | |
| IgnoredActivityNum | int32 | The number of activities flagged as 'ignored' within AllActivities array. | Session/Activity/SConcertSessionActivities.h | |
| LoadingDetailsPanel | TSharedPtr< SWidget > | The widget displayed when details of a partially sync activity (if detail area is expanded) are being fetched from the server. | Session/Activity/SConcertSessionActivities.h | |
| LockActivitiesVisibility | TAttribute< EVisibility > | Whether the lock/unlock activities are displayed. | Session/Activity/SConcertSessionActivities.h | |
| MakeColumnOverlayWidgetFn | FMakeColumnOverlayWidgetFunc | Used to overlay a widget over a column widget (add an extra layer above the normal one) | Session/Activity/SConcertSessionActivities.h | |
| NoDetailsPanel | TSharedPtr< SBox > | The widget saying they are no detail available (if detail area is expanded) when the activity has no details or no activity is selected. | Session/Activity/SConcertSessionActivities.h | |
| OnContextMenuOpening | FOnContextMenuOpening | If bound, invoked when an item in the table is right-click and we are supposed to show a menu of actions. | Session/Activity/SConcertSessionActivities.h | |
| PackageActivitiesVisibility | TAttribute< EVisibility > | Whether the package activities are displayed. | Session/Activity/SConcertSessionActivities.h | |
| PackageDetailsPanel | TSharedPtr< SPackageDetails > | The widget displaying package details (if detail area is expanded) when a package activity is selected. | Session/Activity/SConcertSessionActivities.h | |
| ReplicationActivitiesVisibility | TAttribute< EVisibility > | Whether the replication activities are displayed. | Session/Activity/SConcertSessionActivities.h | |
| SearchTextFilter | TSharedPtr< TTextFilter< const FConcertSessionActivity & > > | Utility class used to tokenize and match text displayed in the list view. | Session/Activity/SConcertSessionActivities.h | |
| TimeFormat | TAttribute< ETimeFormat > | Whether the time should be displayed as relative (9 seconds ago) or as absolute (July 10, 2019 - 10:20:10) | Session/Activity/SConcertSessionActivities.h | |
| TransactionActivitiesVisibility | TAttribute< EVisibility > | Whether the transaction activities are displayed. | Session/Activity/SConcertSessionActivities.h | |
| TransactionDetailsPanel | TSharedPtr< SUndoHistoryDetails > | The widget displaying transaction details (if detail area is expanded) when a transaction activity is selected. | Session/Activity/SConcertSessionActivities.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Append
(
TSharedPtr< FConcertSessionActivity > Activity |
Append an activity to the view. Used to populate the view from a live session. | Session/Activity/SConcertSessionActivities.h | |
void Construct
(
const FArguments& InArgs |
Construct the recovery widget. | Session/Activity/SConcertSessionActivities.h | |
const TArray< TSharedPtr< FConcertSessionActivity > > & GetActivities() |
Session/Activity/SConcertSessionActivities.h | ||
TOptional< FConcertClientInfo > GetClientInfo
(
const FGuid& Guid |
Session/Activity/SConcertSessionActivities.h | ||
int32 GetDisplayedActivityNum() |
Returns the number of activities shown. | Session/Activity/SConcertSessionActivities.h | |
TSharedPtr< SHeaderRow > GetHeaderRow() |
Session/Activity/SConcertSessionActivities.h | ||
const TAttribute< FText > & GetHighlightText() |
Session/Activity/SConcertSessionActivities.h | ||
int32 GetIgnoredActivityNum() |
Returns the number of activities marked as 'ignored'. | Session/Activity/SConcertSessionActivities.h | |
TSharedPtr< FConcertSessionActivity > GetMostRecentActivity() |
Returns the most recent activity available, ignoring the current filter. | Session/Activity/SConcertSessionActivities.h | |
TArray< TSharedPtr< FConcertSessionActivity > > GetSelectedActivities() |
Returns all selected activities | Session/Activity/SConcertSessionActivities.h | |
TSharedPtr< FConcertSessionActivity > GetSelectedActivity() |
Returns the activity selected or null if none is selected. | Session/Activity/SConcertSessionActivities.h | |
const TAttribute< ETimeFormat > & GetTimeFormat() |
Session/Activity/SConcertSessionActivities.h | ||
int32 GetTotalActivityNum() |
Returns the total number of activities currently stored (no filter applied). | Session/Activity/SConcertSessionActivities.h | |
bool IsLastColumn
(
const FName& ColumnId |
Returns true if the column names is the last one (most right one). | Session/Activity/SConcertSessionActivities.h | |
void OnColumnVisibilitySettingsChanged
(
const FColumnVisibilitySnapshot& ColumnSnapshot |
Session/Activity/SConcertSessionActivities.h | ||
void RequestRefresh() |
Request the view to refresh. | Session/Activity/SConcertSessionActivities.h | |
void ResetActivityList() |
Clears all activities displayed. | Session/Activity/SConcertSessionActivities.h | |
void SetSelectedActivities
(
const TArray< TSharedPtr< FConcertSessionActivity > >& ActivitiesToSelect |
Session/Activity/SConcertSessionActivities.h | ||
| Asks the view to update the text search filter. | Session/Activity/SConcertSessionActivities.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Tick
(
const FGeometry& AllottedGeometry, |
Requests and consumes more activities if needed and/or possible. | Session/Activity/SConcertSessionActivities.h |