FMessageLogListingViewModel

The non-UI solution specific presentation logic for a collection of messages for a particular system.

Unreal Engine C++ API Reference > Developer > MessageLog > Presentation

Inheritance Hierarchy

References

   
Module MessageLog
Header /Engine/Source/Developer/MessageLog/Public/Presentation/MessageLogListingViewModel.h
Include #include "Presentation/MessageLogListingViewModel.h"

Syntax

class FMessageLogListingViewModel :  
    public [TSharedFromThis< FMessageLogListingViewModel >](API\Runtime\Core\Templates\TSharedFromThis),  
    public [IMessageLogListing](API\Developer\MessageLog\IMessageLogListing)  

Remarks

The non-UI solution specific presentation logic for a collection of messages for a particular system.

Constructors

Type Name Description
  FMessageLogListingViewModel ()  

Destructors

Type Name Description
  ~FMessageLogListingViewModel ()  

Functions

Type Name Description
TSharedRef< ... Create ( const TSharedRef< FMessageLogListin..., const FText& InLogLabel, const FMessageLogInitializationOpti... ) Factory method which creates a new FMessageLogListingViewModel object
bool GetAllowClear () Get whether we should show allow the user to clear the log.
uint32 GetCurrentPageIndex () Get the current page index we are viewing
bool GetDiscardDuplicates () Get whether we should discard duplicates or not
MessageConta... GetFilteredMessageIterator () Obtains a const iterator to the filtered messages
const TArray... GetFilteredMessages () Returns the filtered message list
uint32 GetMaxPageCount () Get the maximum page count this log can hold
const TShare... GetMessageAtIndex ( const int32 MessageIndex ) Returns the message at the specified index in the filtered list
uint32 GetPageCount () Get the number of pages we can view
const FText ... GetPageTitle ( const uint32 PageIndex ) Get the title of the page at the specified index
bool GetScrollToBottom () Get whether we should scroll to the bottom when messages are added
MessageConta... GetSelectedMessageIterator () Obtains a const iterator to the selected filtered messages list
bool GetShowFilters () Get whether we should show filters or not
bool GetShowPages () Get whether we should show pages or not
void Initialize () End IMessageLogListing interface Initializes the FMessageLogListingViewModel for use
void NextPage () Go to the page at the index after the current
uint32 NumMessages () Gets the number of messages in the current log page
void OnChanged () Called when data is changed changed/updated in the model
void OnFilterChanged () Handles updating the viewmodel when one of its filters changes
void PrevPage () Go to the page at the index before the current
void SetAllowClear ( bool bInAllowClear ) Set whether we should show allow the user to clear the log.
void SetCurrentPageIndex ( uint32 InCurrentPageIndex ) Set the current page index we are viewing
void SetDiscardDuplicates ( bool bInDiscardDuplicates ) Set whether we should discard duplicates or not
void SetMaxPageCount ( uint32 InMaxPageCount ) Set the maximum page count this log can hold
void SetScrollToBottom ( bool bInScrollToBottom ) Set whether we should scroll to the bottom when messages are added
void SetShowFilters ( bool bInShowFilters ) Set whether we should show filters or not
void SetShowPages ( bool bInShowPages ) Set whether we should show pages or not
bool ShouldShowInLogWindow () Get whether to show this log in the main log window

Overridden from IMessageLogListing

Type Name Description
void ClearMessages () Clears messages (if paged, in the current page)
void ClearSelectedMessages () Clears the message selection
void ExecuteToken ( const TSharedRef< class IMessageTok... ) Performs an operation depending on the token (execute hyperlink etc.)
FString GetAllMessagesAsString () Gets all the unfiltered messages as a single piece of text
const TArray... GetFilteredMessages () Gets a list of the filtered messages for the specific log listing
const FText ... GetLabel () Gets the message log listing label
const TArray... GetMessageFilters () Gets the set of message filters used when displaying messages
const FName ... GetName () Gets the message log listing unique name
const TArray... GetSelectedMessages () Gets a list of the selected messages for the specific log listing
FString GetSelectedMessagesAsString () Gets all the unfiltered selected messages as a single piece of text
void InvertSelectedMessages () Inverts the message selection
bool IsMessageSelected ( const TSharedRef< class FTokenizedM... ) Get the message selection state
IMessageLogL... OnDataChanged ()  
IMessageLogL... OnMessageTokenClicked ()  
IMessageLogL... OnPageSelectionChanged ()  
IMessageLogL... OnSelectionChanged ()  
void SelectMessage ( const TSharedRef< class FTokenizedM..., bool bSelected ) Set the message selection state
void SelectMessages ( const TArray< TSharedRef< class FTo... ) Sets multiple selected messages
void SetLabel ( const FText& InLogLabel ) Sets the message log listing label

Overridden from IMessageLog

Type Name Description
void AddMessage ( const TSharedRef< class FTokenizedM..., bool bMirrorToOutputLog ) Begin IMessageLogListing interface
void AddMessages ( const TArray< TSharedRef< class FTo..., bool bMirrorToOutputLog ) Appends multiple messages
void NewPage ( const FText& Title ) Adds a new page to the log.
void NotifyIfAnyMessages ( const FText& Message, EMessageSeverity::Type SeverityFilt..., bool bForce ) Notify the user if there are any messages on the current page for this log.
int32 NumMessages ( EMessageSeverity::Type SeverityFilt... ) Checks to see if there are any messages according to the passed-in severity
void Open () Opens up the message log to this listing.
void SetCurrentPage ( const FText& Title ) Sets the current page to the one specified by the title.
void SetCurrentPage ( const uint32 InOldPageIndex ) Sets the current page to the one specified by the title.

Constants

Name Description
NextNotificationId  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library