Navigation
API > API/Plugins > API/Plugins/ConcertSharedSlate
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.
| Name | SConcertSessionBrowser |
| Type | class |
| Header File | /Engine/Plugins/Developer/Concert/ConcertUI/ConcertSharedSlate/Source/ConcertSharedSlate/Public/Session/Browser/SConcertSessionBrowser.h |
| Include Path | #include "Session/Browser/SConcertSessionBrowser.h" |
Syntax
class SConcertSessionBrowser : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SConcertSessionBrowser
- FSlateControlledConstruction → SWidget → SCompoundWidget → SConcertSessionBrowser
Structs
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveSessionsGroupItem | TSharedPtr< FConcertActiveGroupTreeItem > | Groups all active sessions under it | Session/Browser/SConcertSessionBrowser.h | |
| ArchivedSessionsGroupItem | TSharedPtr< FConcertArchivedGroupTreeItem > | Groups all archived sessions under it | Session/Browser/SConcertSessionBrowser.h | |
| AskUserToDeleteSessions | FCanRemoveSessions | Session/Browser/SConcertSessionBrowser.h | ||
| bRefreshSessionFilter | bool | Session/Browser/SConcertSessionBrowser.h | ||
| Clients | TArray< TSharedPtr< FConcertSessionClientInfo > > | Session/Browser/SConcertSessionBrowser.h | ||
| ClientsArea | TSharedPtr< SExpandableArea > | Session/Browser/SConcertSessionBrowser.h | ||
| Controller | TWeakPtr< IConcertSessionBrowserController > | Gives access to the concert data (servers, sessions, clients, etc). | Session/Browser/SConcertSessionBrowser.h | |
| DefaultServerUrl | TAttribute< FString > | Optional default server url - relevant for highlighting | Session/Browser/SConcertSessionBrowser.h | |
| DefaultSessionName | TAttribute< FString > | Optional default session name - relevant for highlighting | Session/Browser/SConcertSessionBrowser.h | |
| DetailsArea | TSharedPtr< SExpandableArea > | Session/Browser/SConcertSessionBrowser.h | ||
| EditableSessionRow | TSharedPtr< FConcertSessionTreeItem > | The item corresponding to a row used to create/archive/restore a session. There is only one at the time. | Session/Browser/SConcertSessionBrowser.h | |
| EditableSessionRowParent | TSharedPtr< FConcertSessionTreeItem > | Session/Browser/SConcertSessionBrowser.h | ||
| ExtendSessionContextMenu | FExtendSessionContextMenu | Session/Browser/SConcertSessionBrowser.h | ||
| LastDefaultServerUrl | FString | Session/Browser/SConcertSessionBrowser.h | ||
| OnArchivedSessionDoubleClicked | FSessionDelegate | If unset, the default behaviour is to rename the session. | Session/Browser/SConcertSessionBrowser.h | |
| OnLiveSessionDoubleClicked | FSessionDelegate | Session/Browser/SConcertSessionBrowser.h | ||
| OnSessionClicked | FSessionDelegate | Called when a live or archived session is clicked | Session/Browser/SConcertSessionBrowser.h | |
| PersistentSettings | UConcertSessionBrowserSettings * | Keeps persistent user preferences, like the filters. | Session/Browser/SConcertSessionBrowser.h | |
| PostRequestedDeleteSession | FSessionListDelegate | Called after a live or archived session was requested to be deleted (it may or may not have been deleted). | Session/Browser/SConcertSessionBrowser.h | |
| PrimarySortedColumn | FName | Session/Browser/SConcertSessionBrowser.h | ||
| PrimarySortMode | EColumnSortMode::Type | Sorting. | Session/Browser/SConcertSessionBrowser.h | |
| SearchBox | TSharedPtr< SSearchBox > | Filtering. | Session/Browser/SConcertSessionBrowser.h | |
| SearchedText | TSharedPtr< FText > | Session/Browser/SConcertSessionBrowser.h | ||
| SearchTextFilter | TSharedPtr< TTextFilter< const FConcertSessionTreeItem & > > | Session/Browser/SConcertSessionBrowser.h | ||
| SecondarySortedColumn | FName | Session/Browser/SConcertSessionBrowser.h | ||
| SecondarySortMode | EColumnSortMode::Type | Session/Browser/SConcertSessionBrowser.h | ||
| SessionDetailsView | TSharedPtr< SBorder > | Selected Session Details. | Session/Browser/SConcertSessionBrowser.h | |
| SessionHeaderRow | TSharedPtr< SHeaderRow > | Session/Browser/SConcertSessionBrowser.h | ||
| Sessions | TArray< TSharedPtr< FConcertSessionTreeItem > > | The items displayed in the session list view. | Session/Browser/SConcertSessionBrowser.h | |
| SessionsView | TSharedPtr< STreeView< TSharedPtr< FConcertTreeItem > > > | The session list view. | Session/Browser/SConcertSessionBrowser.h | |
| TreeItemSource | TArray< TSharedPtr< FConcertTreeItem > > | ItemSource for SessionsView containing Sessions, ActiveGroup, and ArchivedGroup | Session/Browser/SConcertSessionBrowser.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs, |
Constructs the Browser. | Session/Browser/SConcertSessionBrowser.h | |
TArray< TSharedPtr< FConcertSessionTreeItem > > GetSelectedItems() |
Session/Browser/SConcertSessionBrowser.h | ||
bool HasAnySessions() |
Session/Browser/SConcertSessionBrowser.h | ||
void InsertNewSessionEditableRow () |
Adds row for creating new session. | Session/Browser/SConcertSessionBrowser.h | |
void InsertRestoreSessionAsEditableRow
(
const TSharedPtr< FConcertSessionTreeItem >& ArchivedItem |
Creates row under the given (archived) session with which session can be restored. | Session/Browser/SConcertSessionBrowser.h | |
bool IsArchiveButtonEnabled() |
Session/Browser/SConcertSessionBrowser.h | ||
bool IsDeleteButtonEnabled() |
Session/Browser/SConcertSessionBrowser.h | ||
bool IsNewButtonEnabled() |
Session/Browser/SConcertSessionBrowser.h | ||
bool IsRenameButtonEnabled() |
Session/Browser/SConcertSessionBrowser.h | ||
bool IsRestoreButtonEnabled() |
Session/Browser/SConcertSessionBrowser.h | ||
void RefreshSessionList() |
Session/Browser/SConcertSessionBrowser.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Session/Browser/SConcertSessionBrowser.h | |||
virtual void Tick
(
const FGeometry& AllottedGeometry, |
Session/Browser/SConcertSessionBrowser.h |