Navigation
API > API/Developer > API/Developer/MessageLog
The non-UI solution specific presentation logic for a collection of messages for a particular system.
| Name | FMessageLogListingViewModel |
| Type | class |
| Header File | /Engine/Source/Developer/MessageLog/Public/Presentation/MessageLogListingViewModel.h |
| Include Path | #include "Presentation/MessageLogListingViewModel.h" |
Syntax
class FMessageLogListingViewModel :
public TSharedFromThis< FMessageLogListingViewModel >,
public IMessageLogListing
Inheritance Hierarchy
- TSharedFromThis< FMessageLogListingViewModel > → FMessageLogListingViewModel
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMessageLogListingViewModel
(
TSharedPtr< FMessageLogListingModel > InMessageLogListingModel, |
Presentation/MessageLogListingViewModel.h | ||
| Presentation/MessageLogListingViewModel.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FMessageLogListingViewModel() |
Presentation/MessageLogListingViewModel.h |
Structs
| Name | Remarks |
|---|---|
| FOpenNotification | All open notifications |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| NextNotificationId | int32 | Presentation/MessageLogListingViewModel.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAllowClear | bool | Whether we allow the user to clear the log. | Presentation/MessageLogListingViewModel.h | |
| bDiscardDuplicates | bool | Whether to check for duplicate messages & discard them | Presentation/MessageLogListingViewModel.h | |
| bIsRefreshing | bool | Tracks if the viewmodel is in the middle of refreshing | Presentation/MessageLogListingViewModel.h | |
| bScrollToBottom | bool | Whether to scroll to the bottom when messages are added | Presentation/MessageLogListingViewModel.h | |
| bShowFilters | bool | Whether filters should be shown for this listing | Presentation/MessageLogListingViewModel.h | |
| bShowInLogWindow | bool | Whether to show this log in the main log window | Presentation/MessageLogListingViewModel.h | |
| bShowPages | bool | Whether pages should be used/shown for this listing | Presentation/MessageLogListingViewModel.h | |
| ChangedEvent | FChangedEvent | Delegate to call when model data is changed | Presentation/MessageLogListingViewModel.h | |
| CurrentPageIndex | uint32 | The currently displayed page index | Presentation/MessageLogListingViewModel.h | |
| FilteredMessages | MessageContainer | The same list of messages in the model after filtering is applied | Presentation/MessageLogListingViewModel.h | |
| LogLabel | FText | Label of the listing, displayed to users | Presentation/MessageLogListingViewModel.h | |
| MaxPageCount | uint32 | The limit on the number of displayed pages for this listing | Presentation/MessageLogListingViewModel.h | |
| MessageFilters | TArray< TSharedRef< FMessageFilter > > | The array of message filters used on this listing | Presentation/MessageLogListingViewModel.h | |
| MessageLogListingModel | TSharedPtr< FMessageLogListingModel > | The model we are getting display info from | Presentation/MessageLogListingViewModel.h | |
| OpenNotifications | TArray< FOpenNotification > | Presentation/MessageLogListingViewModel.h | ||
| PageSelectionChangedEvent | FOnPageSelectionChangedEvent | Delegate to call when page selection state is changed | Presentation/MessageLogListingViewModel.h | |
| SelectedFilteredMessages | MessageContainer | The list of selected messages | Presentation/MessageLogListingViewModel.h | |
| SelectionChangedEvent | FOnSelectionChangedEvent | Delegate to call when selection state is changed | Presentation/MessageLogListingViewModel.h | |
| TokenClickedEvent | IMessageTokenClickedEvent | Delegate to call when a token is clicked | Presentation/MessageLogListingViewModel.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddMessage
(
const TSharedRef< class FTokenizedMessage >& NewMessage, |
Begin IMessageLogListing interface | Presentation/MessageLogListingViewModel.h | |
virtual void AddMessages
(
const TArray< TSharedRef< class FTokenizedMessage > >& NewMessages, |
Presentation/MessageLogListingViewModel.h | ||
bool GetAllowClear() |
Get whether we should show allow the user to clear the log. | Presentation/MessageLogListingViewModel.h | |
uint32 GetCurrentPageIndex() |
Get the current page index we are viewing | Presentation/MessageLogListingViewModel.h | |
bool GetDiscardDuplicates() |
Get whether we should discard duplicates or not | Presentation/MessageLogListingViewModel.h | |
MessageContainer::TConstIterator GetFilteredMessageIterator() |
Obtains a const iterator to the filtered messages | Presentation/MessageLogListingViewModel.h | |
const TArray< TSharedRef< FTokenizedMessage > > & GetFilteredMessages () |
Returns the filtered message list | Presentation/MessageLogListingViewModel.h | |
uint32 GetMaxPageCount() |
Get the maximum page count this log can hold | Presentation/MessageLogListingViewModel.h | |
const TSharedPtr< FTokenizedMessage > GetMessageAtIndex
(
const int32 MessageIndex |
Returns the message at the specified index in the filtered list | Presentation/MessageLogListingViewModel.h | |
uint32 GetPageCount() |
Get the number of pages we can view | Presentation/MessageLogListingViewModel.h | |
const FText & GetPageTitle
(
const uint32 PageIndex |
Get the title of the page at the specified index | Presentation/MessageLogListingViewModel.h | |
bool GetScrollToBottom() |
Get whether we should scroll to the bottom when messages are added | Presentation/MessageLogListingViewModel.h | |
MessageContainer::TConstIterator GetSelectedMessageIterator() |
Obtains a const iterator to the selected filtered messages list | Presentation/MessageLogListingViewModel.h | |
bool GetShowFilters() |
Get whether we should show filters or not | Presentation/MessageLogListingViewModel.h | |
bool GetShowPages() |
Get whether we should show pages or not | Presentation/MessageLogListingViewModel.h | |
virtual void Initialize() |
End IMessageLogListing interface Initializes the FMessageLogListingViewModel for use | Presentation/MessageLogListingViewModel.h | |
virtual void NewPage
(
const FText& Title |
Presentation/MessageLogListingViewModel.h | ||
void NextPage() |
Go to the page at the index after the current | Presentation/MessageLogListingViewModel.h | |
virtual void NotifyIfAnyMessages
(
const FText& Message, |
Presentation/MessageLogListingViewModel.h | ||
uint32 NumMessages () |
Gets the number of messages in the current log page | Presentation/MessageLogListingViewModel.h | |
virtual int32 NumMessages
(
EMessageSeverity::Type SeverityFilter |
Presentation/MessageLogListingViewModel.h | ||
virtual void OnChanged() |
Called when data is changed changed/updated in the model | Presentation/MessageLogListingViewModel.h | |
void OnFilterChanged() |
Handles updating the viewmodel when one of its filters changes | Presentation/MessageLogListingViewModel.h | |
virtual void Open() |
Presentation/MessageLogListingViewModel.h | ||
void PrevPage() |
Go to the page at the index before the current | Presentation/MessageLogListingViewModel.h | |
void SetAllowClear
(
bool bInAllowClear |
Set whether we should show allow the user to clear the log. | Presentation/MessageLogListingViewModel.h | |
virtual void SetCurrentPage
(
const FText& Title |
Presentation/MessageLogListingViewModel.h | ||
virtual void SetCurrentPage
(
const uint32 InOldPageIndex |
Presentation/MessageLogListingViewModel.h | ||
void SetCurrentPageIndex
(
uint32 InCurrentPageIndex |
Set the current page index we are viewing | Presentation/MessageLogListingViewModel.h | |
void SetDiscardDuplicates
(
bool bInDiscardDuplicates |
Set whether we should discard duplicates or not | Presentation/MessageLogListingViewModel.h | |
void SetMaxPageCount
(
uint32 InMaxPageCount |
Set the maximum page count this log can hold | Presentation/MessageLogListingViewModel.h | |
void SetScrollToBottom
(
bool bInScrollToBottom |
Set whether we should scroll to the bottom when messages are added | Presentation/MessageLogListingViewModel.h | |
void SetShowFilters
(
bool bInShowFilters |
Set whether we should show filters or not | Presentation/MessageLogListingViewModel.h | |
void SetShowPages
(
bool bInShowPages |
Set whether we should show pages or not | Presentation/MessageLogListingViewModel.h | |
bool ShouldShowInLogWindow() |
Get whether to show this log in the main log window | Presentation/MessageLogListingViewModel.h |
Overridden from IMessageLogListing
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ClearMessages() |
Clears messages (if paged, in the current page) | Presentation/MessageLogListingViewModel.h | |
virtual void ClearSelectedMessages() |
Clears the message selection | Presentation/MessageLogListingViewModel.h | |
virtual void ExecuteToken
(
const TSharedRef< class IMessageToken >& Token |
Performs an operation depending on the token (execute hyperlink etc.) | Presentation/MessageLogListingViewModel.h | |
virtual FString GetAllMessagesAsString() |
Gets all the unfiltered messages as a single piece of text | Presentation/MessageLogListingViewModel.h | |
virtual const TArray< TSharedRef< class FTokenizedMessage > > & GetFilteredMessages () |
Gets a list of the filtered messages for the specific log listing | Presentation/MessageLogListingViewModel.h | |
virtual const FText & GetLabel() |
Gets the message log listing label | Presentation/MessageLogListingViewModel.h | |
virtual const TArray< TSharedRef< FMessageFilter > > & GetMessageFilters() |
Gets the set of message filters used when displaying messages | Presentation/MessageLogListingViewModel.h | |
virtual const FName & GetName() |
Gets the message log listing unique name | Presentation/MessageLogListingViewModel.h | |
virtual const TArray< TSharedRef< class FTokenizedMessage > > & GetSelectedMessages() |
Gets a list of the selected messages for the specific log listing | Presentation/MessageLogListingViewModel.h | |
virtual FString GetSelectedMessagesAsString() |
Gets all the unfiltered selected messages as a single piece of text | Presentation/MessageLogListingViewModel.h | |
virtual void InvertSelectedMessages() |
Inverts the message selection | Presentation/MessageLogListingViewModel.h | |
virtual bool IsMessageSelected
(
const TSharedRef< class FTokenizedMessage >& Message |
Get the message selection state | Presentation/MessageLogListingViewModel.h | |
virtual IMessageLogListing::FChangedEvent & OnDataChanged() |
Presentation/MessageLogListingViewModel.h | ||
virtual IMessageLogListing::IMessageTokenClickedEvent & OnMessageTokenClicked() |
Presentation/MessageLogListingViewModel.h | ||
virtual IMessageLogListing::FOnPageSelectionChangedEvent & OnPageSelectionChanged() |
Presentation/MessageLogListingViewModel.h | ||
virtual IMessageLogListing::FOnSelectionChangedEvent & OnSelectionChanged() |
Presentation/MessageLogListingViewModel.h | ||
virtual void SelectMessage
(
const TSharedRef< class FTokenizedMessage >& Message, |
Set the message selection state | Presentation/MessageLogListingViewModel.h | |
virtual void SelectMessages
(
const TArray< TSharedRef< class FTokenizedMessage > >& InSelectedMessages |
Sets multiple selected messages | Presentation/MessageLogListingViewModel.h | |
virtual void SetLabel
(
const FText& InLogLabel |
Sets the message log listing label | Presentation/MessageLogListingViewModel.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedRef< FMessageLogListingViewModel > Create
(
const TSharedRef< FMessageLogListingModel >& InMessageLogListingModel, |
Factory method which creates a new FMessageLogListingViewModel object | Presentation/MessageLogListingViewModel.h |