FMessageLogListingModel

This class represents a set of rich tokenized messages for a particular system

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

Inheritance Hierarchy

References

   
Module MessageLog
Header /Engine/Source/Developer/MessageLog/Public/Model/MessageLogListingModel.h
Include #include "Model/MessageLogListingModel.h"

Syntax

class FMessageLogListingModel : public [TSharedFromThis< FMessageLogListingModel >](API\Runtime\Core\Templates\TSharedFromThis)  

Remarks

This class represents a set of rich tokenized messages for a particular system

Constructors

No constructors are accessible with public or protected access.

Destructors

Type Name Description
  ~FMessageLogListingModel ()  

Functions

Type Name Description
void AddMessage ( const TSharedRef< FTokenizedMessage..., bool bMirrorToOutputLog, bool bDiscardDuplicates ) Appends a message
void AddMessages ( const TArray< TSharedRef< FTokenize..., bool bMirrorToOutputLog, bool bDiscardDuplicates ) Appends multiple messages
bool AreMessagesEqual ( const TSharedRef< FTokenizedMessage..., const TSharedRef< FTokenizedMessage... ) Helper function for RemoveDuplicates(), exposed so the ViewModel can use it too
void ClearMessages () Clears all messages
TSharedRef< ... Create ( const FName& InLogName ) Factory method which creates a new FMessageLogListingModel object
void CreateNewPageIfRequired () Create a new page if we have one pending
FPage & CurrentPage () Access the current page (we only add messages to this page
FString GetAllMessagesAsString ( const uint32 PageIndex ) Gets all messages as a string
const TShare... GetMessageAtIndex ( const uint32 PageIndex, const int32 MessageIndex ) Returns the message at the specified index
MessageConta... GetMessageIterator ( uint32 PageIndex ) Obtains a const iterator to the message data structure
const FName ... GetName () Retrieves the name identifier for this log listing
const FText ... GetPageTitle ( const uint32 PageIndex ) Get the title of the page at the specified index
void NewPage ( const FText& InTitle, uint32 InMaxPages ) Add a new page.
void Notify () Will broadcast to all registered observers informing them of a change
uint32 NumMessages ( uint32 PageIndex ) Get the number of messages on the passed-in page
uint32 NumPages () Get the number of pages contained in this log
FMessageLogL... OnChanged ()  
FPage * PageAtIndex ( const uint32 PageIndex ) Get a page by index - uses cache to speed up linked list access
void RemoveDuplicates ( uint32 PageIndex ) Remove any messages that are duplicates of one another - O(n)
int32 ReplaceMessage ( const TSharedRef< FTokenizedMessage..., const uint32 PageIndex, const int32 MessageIndex ) Replaces the message at the given index
bool SetCurrentPage ( const uint32 InOldPageIndex ) Sets the current page to the one specified by the index.
bool SetCurrentPage ( const FText& InTitle, uint32 InMaxPages ) Sets the current page to the one specified by the title.

Classes

Type Name Description
Public class FChangedEvent Broadcasts whenever the message log listing changes
Protected struct FPage  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library